domoja-sample
v1.4.5
Published
A sample Domoja module skeleton
Downloads
28
Readme
domoja-sample
This is a skeleton for developing a new domoja module.
A module extend Domoja functionality, by adding new sources, devices, etc. It is essentially an npm
module following particular specifications:
- its name must start with
domoja-
- it must derive from
domoModule
Sources
A source derives from the Source
class and implements the following methods:
createInstance
: create an instance of the source, taking into account the requested configurationgetParameters
: describes the parameters supported by the sourcedoSetAttribute
: implements a requested change of value of an attribute of a device managed by the sourcerelease
: releases a source to free any used resourceregisterDeviceTypes
: a static method to declare which device types are supported by the source