Description

culfw is a GPL'd firmware for the CUL family of devices.

Current Version: (as of 2017-09-07) is 1.67. See the CHANGED file for current changes.

culfw is used in conjunction with the CUL/CUN/CUR and a high level software like fhem to automate some common tasks in the household like switching lamps / shutters / heating / etc. and to log events like temperature/humidity/power consumption.
CUL is a device which is attached to the PC, making it capable to receive and send 868MHz RF signals. culfw is the firmware which implements some RF protocols on the CUL, and makes them useable by fhem, which runs on the PC and coordinates all the tasks.

Hardware Following devices are known to work with culfw: CUL (CC1101 USB Light, at the bottom) CUN (CC1101 USB Network, to the left) CUNO (CC1101 USB Network + OneWire, similar to the CUN) CUR (CC1101 USB Remote, prototype, to the right) rpiaddon (CC1101 Raspberry PI AddOn board with OneWire, display and sensors) At the heart of the CUL family of devices is the Texas Instruments CC1101 RF IC and an Atmel CPU. The radio interface is tuned for 868MHz (or 433MHz). Both the CUN and the CUR have some oboard flash (2MB) for local logging. The CUN has an enc28j60 Ethernet chip, the CUR a pcf8833 (130x130 pixel, 12bit) display controller. CPUs ( CPU-type / RAM / Program memory): CUL V1/V2: at90usb162 / 0.5 kB / 16 kB CUL V3: atmega32U4 / 2.5 kB / 32 kB CUN: at90usb64 / 2.0 kB / 64 kB CUNO: atmega644p / 2.0 kB / 64 kB CUNO2: atmega1284p / 16 kB / 128 kB CUR V1: at90usb128 / 4.0 kB / 128 kB CUR V2: at90usb64 / 2.0 kB / 64 kB rpiaddon: atmega644p / 4.0 kB / 64 kB From the program memory 4kB is used by the USB-Bootloader, and 4kB by the LUFA USB library.

Features

culfw supports following RF protocols: "SlowRF" mode (1kHz datarate, AM) FS20: send/receive There are numerous FS20 devices, AFAIK. all of them are fully supported. FHT: send/receive Communication to the FHT80b and directly to the FHT8v is supported. Sending out FHT80TF data pakets to FHT80b. S300: receive Examples of such devices: S300TH, KS300-2 EM1000: receive Devices: EM1000FM, EM1000GZ, EM1000WZ HMS: receive Devices: There are numerous HMS devices, AFAIK. all of them are fully supported. Hoermann: receive Some 868 Hoermann garage door openers. ESA2000: send and receive Lacrosse TX2/TX3: receive Intertechno: send Somfy RTS: send BidCos(R) in the "AskSin" mode (20kHz datarate, FM). HomeMatic(R) Wireless devices use this protocol. MAX! in the "MORITZ" mode When configured as an RFR (RF-Router) client, then a CUL plugged into a wall socket can communicate via high-speed RF to the base, while serving all the SlowRF protocols. CUNO: OneWire and InfraRed support.

Installation

Step 1: flashing the firmware

Download the firmware (see the links below) and unpack it. Change into your device directory (e.g. Devices/CUL)

• Insert the device into the USB slot while pressing the micro-switch.
• CUL/CUN @ Linux or OSX:
  Install the package dfu-programmer, then execute "make usbprogram". After flashing the CUL, a new USB device should appear: "03eb:204b Atmel Corp.". If not reinsert the device without pressing the micro-switch.
• CUL/CUN @ Windows:
  See also this link for details (german). Do no install any drivers. Get the Windows Flash tool "FLIP" from Atmel, start it, detect the CUL and flash the file CUL.hex to it.
• CUNO:
  Install the package avrdude and check the makefile for the correct port (look for AVRDUDE_PORT). Then execute "make usbprogram".
• rpiaddon:
  Install the package avrdude and then execute "make program".

Step 2: Using the device

• Linux:
  The device should appear as /dev/ttyACM0 (check /var/log/messages). To test it start "screen /dev/ttyACM0", and then type V. The version string should appear. To use the device in fhem, define it as a CUL instance: "define MyCUL CUL /dev/ttyACM0 1234". See the fhem documentation for details.
  For the rpiaddon replace ttyACM0 with ttyAMA0.
• Windows:
  Right-click on the docs/MyUSB_USBtoSerial.inf file, and install it.
  Then install a virtual COM port: Locate the COM-port in the device manager shown as "USB Virtual Serial Port (COMx)". Start Hyperterminal, open a connection to COMx 9600,8,n,1.
  Type "V". The string "V 1.0..." should appear. Type X01 to enable the data reporting.
• CUN over TCP/IP:
  Connect the device to a network with a DHCP server, and then telnet to the assigned IP address with "telnet ip-adress 2323"

Read the commandref.html file for more details.

Links:

Hardware: http://www.busware.de
Source (and compiled firmware): http://culfw.de/culfw-1.67.tar.gz
FAQ: http://culfw.de/faq.html
Command reference: http://culfw.de/commandref.html
Forum: FHEM Forum >> CUL >> cul-fans
SVN@sourceforge: https://sourceforge.net/p/culfw/code/HEAD/tree/
"Making of" CUL V3: http://www.youtube.com/watch?v=HsNvnLwz6jQ

License:

Copyright:

• Rudolf Koenig (r dot koenig at koeniglich dot de). Note: I do not provide support via private mail, use the google group instead.
License: GPL (v2)
Thanks to TOSTi for inspiration and numerous other people for help.