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
- Install telldus-core and development libraries, choose one of the following four procedures.
- Windows, Mac: Install Telldus Center -- go here and get the latest version of the appropriate DMG or EXE file and install. Note: You'll need to check "Developer files" during install. You'll also need a version of Visual C++ installed.
- Linux Ubuntu/Debian prebuilt:
- Follow general guide at http://developer.telldus.com/wiki/TellStickInstallationUbuntu
- Install
telldus-core
andlibtelldus-core-dev
- Arch Linux prebuilt:
- Install
telldus-core
- Install
- Linux source install: http://developer.telldus.com/wiki/TellStickInstallationSource
- Clone this project and enter the node-telldus directory
cd node-telldus
- Install node-gyp
npm install node-gyp
- Compile this module
npm install -g
- Link the module to your project
cd yourprojectdirectory
npm link telldus
Installation (From npm):
- Install telldus-core and development libraries, choose one of the following four procedures.
- Windows, Mac: Install Telldus Center -- go here and get the latest version of the appropriate DMG or EXE file and install. Note: You'll need to check "Developer files" during install. You'll also need a version of Visual C++ installed.
- Linux Ubuntu/Debian prebuilt:
- Follow general guide at http://developer.telldus.com/wiki/TellStickInstallationUbuntu
- Install
telldus-core
librarylibtelldus-core-dev
- Arch Linux prebuilt:
- Install
telldus-core
- Install
- Linux source install: http://developer.telldus.com/wiki/TellStickInstallationSource
- Install node-gyp
npm install node-gyp
- Install this module using npm
cd yourprojectdirectory
npm install telldus-legacy
Basic Usage
Make sure telldusd is running on the same machine.
var telldus = ; telldus;
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;
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;
Similar to the command
tdtool --on deviceId
turnOff
Turns a configured device OFF.
Synchronous version: var returnValue = turnOffSync(deviceId);
Signature:
telldus;
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;
addRawDeviceEventListener
Add a listener for raw device events. This is usefull for scanning for devices not yet configured
Signature:
var listener = telldus;
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;
status
: is an object of the form:
{"status": "the status"}
addSensorEventListener
Add a listener for sensor events
Signature:
var listener = telldus;
removeEventListener
Remove a previously added listener.
Synchronous version: javascript var returnValue = telldus.removeEventListenerSync(listener);
Signature:
telldus;
getErrorString
Get the string representation of a return value
Synchronous version: javascript var errStr = telldus.getErrorStringSync(returnValue);
Signature:
var returnValue = telldus;ifreturnValue > 0 telldus;
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