domhaas / cul

nodejs module to interact with busware cul / culfw

cul

This is a Node.js module that can be used to interact with a Busware CUL (USB), COC (RaspberryPi) or SCC (RaspberryPi) running culfw. With CUL/COC/SCC and culfw many RF devices can be controlled, like FS20, MAX!, temperature sensors, weather stations and more. Click here for a full list of supported Devices

Purpose

This module provides a thin abstraction for the serial port communication with CUL/COC/SCC and lightweight parse and command wrappers. It's intended to be used in different Node.js based Home Automation software.

Credits

based on the work of Rudolf Koenig, Author of culfw and fhem (both licensed under GPLv2)

Usage

npm install cul

var Cul = require('cul');
var cul = new Cul();

// ready event is emitted after serial connection is established and culfw acknowledged data reporting
cul.on('ready', function () {
    // send arbitrary commands to culfw
    cul.write('V');
});

cul.on('data', function (raw) {
    // show raw incoming messages
    console.log(raw);
});

Options

• serialport (default: "/dev/ttyAMA0")
• baudrate (default: 9600)
• mode (default: "SlowRF")
  possible values:
  • SlowRF (FS20, HMS, FHT, EM, ...)
  • MORITZ (MAX! devices)
  • AskSin (HomeMatic devices)
• parse (default: true)
  try to parse received messages
• init (default: true)
  auto send "enable datareporting" command when connection is established (depends on chosen mode)
• coc (default: false)
  has to be enabled for usage with COC), changes default baudrate to 38400 and default serialport to /dev/ttyACM0
• scc (default: false)
  has to be enabled for usage with SCC), changes default baudrate to 38400 and default serialport to /dev/ttyAMA0
• rssi (default: true) receive rssi (signal strength) value with every message (works only if init and parse are both true)

pass options when creating a new cul object:

var Cul = require('cul');
var fs20 = new Cul({
    serialport: '/dev/ttyACM0',
    mode: 'SlowRF'
});
var max = new Cul({
    serialport: '/dev/ttyACM1',
    mode: 'MORITZ'
});

Methods

• close( )
  close the serialport connection
• write(raw, callback)
  send message to cul. writes directly to the serialport
  optional callback is passed through to serialport module and is called with params (err, res)
• cmd(protocol, arg1, arg2, ..., callback)
  generate a command and send it to cul (see chapter "predefined commands" below)
  optional callback is passed through to serialport module and is called with params (err, res)

Events

• ready
  called when serialport connection is established and (if init is true) datareporting is enabled
• close
  called when serialport connection is closed
• data(raw, obj)
  called for every received message
  • raw string, contains the raw message received from cul
  • obj object, contains parsed message data (see "data parsing" below)

Sending commands

Raw commands

Example

cul.write('F6C480111'); // Raw command

Predefined commands

(until now only FS20 is implemented)

FS20

Take a look at the file lib/fs20.js - it exports a function cmd(housecode, address, command, time, bidi, res)

example

cul.cmd('FS20', '2341 2131', '1112', 'on'); // house code in ELV-Notation, address in ELV-Notation, command as text
cul.cmd('FS20', '6C48', '01', '11');        // house code as hex string, address as hex string, command as hex string

(these examples result in the same message as the raw command example above.)

Data parsing

The 2nd param obj of the data event contains a object representation of the parsed data.

Each object has the following attributes:

• protocol
  FS20, EM, HMS, WS, MORITZ, ...
• address
  a unique address in this protocol
• device
  device type name
• rssi
  radio signal strength value (only present if option rssi is true)
• data
  a object with the parsed data

Examples

Sample output of

cul.on('data', function (raw, obj) {
    console.log(raw, obj);
});

FS20

F6C480011E5, {
    protocol: 'FS20',
    address: '6C4800',
    device: 'FS20',
    rssi: -87.5,
    data: {
        addressCode: '6C48',
        addressCodeElv: '2341 2131',
        addressDevice: '00',
        addressDeviceElv: '1111',
        extended: false,
        time: null,
        bidirectional: false,
        response: false,
        cmdRaw: '11',
        cmd: 'on'
        
    }
}

EM1000

E020563037A01000200EC, {
    protocol: 'EM',
    address: '0205',
    device: 'EM1000-EM',
    rssi: -84,
    data: { seq: 99, total: 31235, current: 1, peak: 2 }
}

S300TH

K1145525828, {
    protocol: 'WS',
    address: 1,
    device: 'S300TH',
    rssi: -28,
    data: { temperature: 24.5, humidity: 58.5 },
}

Moritz (MAX!)

V 1.66 CSM868 { data: { culfw: { version: '1.66', hardware: 'CSM868' } },
  protocol: 'MORITZ',
  rssi: -22 }
Z0C000442113AD30C4F0D001CB41D { data: 
   { len: 12,
     msgcnt: 0,
     msgFlag: '04',
     msgTypeRaw: '42',
     msgType: 'WallThermostatControl',
     src: '113ad3',
     dst: '0c4f0d',
     groupid: 0,
     payload: '1CB41D',
     desiredTemperature: 14,
     measuredTemperature: 18 },
  protocol: 'MORITZ',
  address: '113ad3',
  device: 'WallMountedThermostat',
  rssi: -59.5 }
Z0E0002020C4F0D113AD3000119001C1E { data: 
   { len: 14,
     msgcnt: 0,
     msgFlag: '02',
     msgTypeRaw: '02',
     msgType: 'Ack',
     src: '0c4f0d',
     dst: '113ad3',
     groupid: 0,
     payload: '0119001C1E',
     dstDevice: 'WallMountedThermostat' },
  protocol: 'MORITZ',
  address: '0c4f0d',
  rssi: -59 }
  Z0B4F06300E3F3C1234560012F7 { data: 
   { len: 11,
     msgcnt: 79,
     msgFlag: '06',
     msgTypeRaw: '30',
     msgType: 'ShutterContactState',
     src: '0e3f3c',
     dst: '123456',
     groupid: 0,
     payload: '12F7',
     isopen: 1,
     unkbits: 4,
     rferror: 0,
     batterlow: 0,
     battery: 'ok' },
  protocol: 'MORITZ',
  address: '0e3f3c',
  device: 'ShutterContact',
  rssi: -78.5 }

Until now only for a few selected devices data parsing is implemented.

protocol	device	should work	tested
FS20	all Devices	✅	✅
HMS	HMS100T	✅	✅
HMS	HMS100TF	✅
EM	EM1000(-EM, -GZ, -WZ)	✅	✅
WS	S300TH	✅	✅
MORITZ	HeatingThermostat	✅
MORITZ	WallMountedThermostat	✅
MORITZ	ShutterContact	✅	✅
MORITZ	PushButton	✅

More can be added easily: take a look at the files in the directory lib/ and find your inspiration on http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/FHEM/

Pull requests welcome!

further reading

• culfw command reference

Todo

• configurable serialport auto reconnect
• more data parser modules
  • MORITZ (MAX!) (inprogress)
  • ESA
  • FHT
  • HMS: HMS100WD, RM100-2, HMS100TFK, HMS100MG, HMS100CO, HMS100FIT
  • ...
• more command modules
  • MORITZ (inprogress)
  • FHT
  • ...
• more tests
• CUNO support

Pull requests welcome! 😄

Credits

• http://culfw.de
• http://fhem.de
• https://github.com/voodootikigod/node-serialport
• https://github.com/netAction/CUL_FS20
• https://github.com/katanapod/COC_FS20

License

Licensed under GPLv2

Copyright (c) 2014-2016 hobbyquaker [email protected]