telldus-legacy

node wrapper for telldus-core, based on telldus-core-js

Usage no npm install needed!

<script type="module">
  import telldusLegacy from 'https://cdn.skypack.dev/telldus-legacy';
</script>

README

telldus-legacy - Node bindings for telldus-core

Latest release is 0.0.10, available at npm using npm install telldus-legacy

NOTE THAT THIS MODULE IS TARGETED AT NODE >= 0.6 and < 0.12.

FOR 0.12 AND LATER USE THE REGULAR "telldus" MODULE.

Installation (From source):

Note that the master branch isn't always top notch. If it doesn't compile, try an older revision or install the stable release

  1. Install telldus-core and development libraries, choose one of the following four procedures.
  2. Clone this project and enter the node-telldus directory cd node-telldus
  3. Install node-gyp npm install node-gyp
  4. Compile this module npm install -g
  5. Link the module to your project cd yourprojectdirectory npm link telldus

Installation (From npm):

  1. Install telldus-core and development libraries, choose one of the following four procedures.
  2. Install node-gyp npm install node-gyp
  3. Install this module using npm cd yourprojectdirectory npm install telldus-legacy

Basic Usage

Make sure telldusd is running on the same machine.

var telldus = require('telldus-legacy');

telldus.getDevices(function(err,devices) {
  if ( err ) {
    console.log('Error: ' + err);
  } else {
    // A list of all configured devices is returned
    console.log(devices);
  }
});

If you ever get a returnValue from a method like turnOnSync that is not equal to 0 (TELLDUS_SUCCESS) you could check what type of error that is using telldus.getErrorString.

API

getDevices

Returns an array of device dictionary objects. Only configured devices are returned.

Synchronous version: javascript var devices = telldus.getDevicesSync();

Signature:

telldus.getDevices(function(err,devices) {
  if ( err ) {
    console.log('Error: ' + err);
  } else {
    // The list of devices is returned
    console.log(devices);
  }
});

[
  {
    id: 1,
    name: 'name from telldus.conf',
    methods: [ 'TURNON', 'TURNOFF' ],
    model: 'codeswitch',
    type: 'DEVICE',
    status: {status: 'OFF'}
  },
  ...
]

turnOn

Turns a configured device ON.

Synchronous version: javascript var returnValue = turnOnSync(deviceId);

Signature:

telldus.turnOn(deviceId,function(err) {
  console.log('deviceId is now ON');
});

Similar to the command

tdtool --on deviceId

turnOff

Turns a configured device OFF.

Synchronous version: var returnValue = turnOffSync(deviceId);

Signature:

telldus.turnOff(deviceId,function(err) {
  console.log('Device' + deviceId + ' is now OFF');
});

Similar to the command

tdtool --off deviceId

dim

Dims a configured device to a certain level.

Synchronous version: javascript var returnValue = dimSync(deviceId,level);

Signature:

telldus.dim(deviceId, level,function(err) {
  console.log('Device ' + deviceId + ' is now dimmed to level ' + level);
});

addRawDeviceEventListener

Add a listener for raw device events. This is usefull for scanning for devices not yet configured

Signature:

var listener = telldus.addRawDeviceEventListener(function(controllerId, data) {
  console.log('Raw device event: ' + data);
});
  • controllerId: id of receiving controller, can identify the TellStick if several exists in the system.
  • data: A semicolon separated string with colon separated key / value pairs.
'class:command;protocol:arctech;model:selflearning;house:5804222;unit:2;group:0;method:turnon;'

addDeviceEventListener

Add a listener for device events

Signature:

var listener = telldus.addDeviceEventListener(function(deviceId, status) {
  console.log('Device ' + deviceId + ' is now ' + status.name);
});
  • status: is an object of the form:
    {"status": "the status"}

addSensorEventListener

Add a listener for sensor events

Signature:

var listener = telldus.addSensorEventListener(function(deviceId,protocol,model,type,value,timestamp) {
  console.log('New sensor event received: ',deviceId,protocol,model,type,value,timestamp);
});

removeEventListener

Remove a previously added listener.

Synchronous version: javascript var returnValue = telldus.removeEventListenerSync(listener); Signature:

telldus.removeEventListener(listener,function(err) {});

getErrorString

Get the string representation of a return value

Synchronous version: javascript var errStr = telldus.getErrorStringSync(returnValue);

Signature:

var returnValue = telldus.turnOnSync(deviceId);
if(returnValue > 0) {
  telldus.getErrorString(returnValue, function (err, errStr) {
    console.error('turnOn failed for device ' + deviceId + ', error: ' + errStr);
    process.exit(0);
  });
}

License and Credits:

This project is licensed under the MIT license and is forked from telldus-core-js (https://github.com/evilmachina/telldus-core-js) by GitHub user evilmachina.

Bugs, issues and feature request:

The sourcecode and bug tracker is hosted on GitHub, https://github.com/Hexagon/node-telldus