mrose17
commented
10 years ago hi. i suspect we're looking at this from the wrong level of abstraction. here is what i would do:
% cd steward
% git pull
% cp drivers/lighting-bulb-template.js to steward/devices/devices-lighting/lighting-lifx.js
% cd stewardthen edit package.json to include this dependency
, "lifx" : "0.1.3"then grab the module
% npm -l installand now start editing
devices/devices-lighting-lifx.js(you may have already done all this, i just want a "level set")
ok, so what do we do in devices-lighting-lifx.js?
you might as well begin by doing a global replace
s/TBD/LIFX/gand then changing
var LIFX = require('LIFX')to
var lifx = require('lifxjs')then at the bottom of the cline and look at this function
exports.start = function() { … };this function is invoked when the module is loaded, it does two things: first, it registers the device prototype, and second it starts discovery of bulbs.
all lighting drivers are required to support an rgb model and then are free to support any other models they prefer. it looks like the LIFX folks like HSL, so you want these properties:
, properties : { name : true
, status : [ 'waiting', 'on', 'off' ]
, color : { model: [ { rgb : { r: 'u8', g: 'u8', b: 'u8' } }
, { hue : { hue: 'degrees', saturation: 'percentage' } }
]
}
, brightness : 'percentage'
}next, let's look at this line which is where discovery is going to take place:
new LIFX().on('discover', function(bulb) { … }it wants to call the lifx module to ask it to inform it whenever a new bulb is found. when that happens the info structure is filled out and the device is "discovered" by the steward. the key thing to note in this callback is that you're passing a "bulb" object that will subsequently be used by the rest of the file to do things. perhaps the single most important thing is to make sure that the info.device.unit.udn is unique and stable for this bulb. in other words, no other bulb should be able to generate that UDN, and if you restart the steward, the same UDN must be generated for that bulb.
so, just eyeballing the README.js file for the lifts repo, i'd say that you are looking at something that starts like this:
var lx = lifx.init().on('bulb', function(bulb) {
// when creating info, be sure to create both info.lx and info.bulb, we'll need them both!
serialNo = bulb.lifxAddress.toString('hex');
…udn = 'uuid:2f402f80-da50-11e1-9b23-' + serialNo;
}).on('bulbstate', function(bulbstate) {
var bulb, udn;
udn = 'uuid:2f402f80-da50-11e1-9b23-' + bulbstate.bulb.lifxAddress.toString('hex');
if (!devices.devices[udn]) return;
bulb = devices.devices[udn].device;
bulb.update(bulb, bulbstate.state);
}).on('bulbonoff, function(bulbonoff) {
var bulb, udn;
udn = 'uuid:2f402f80-da50-11e1-9b23-' + bulbstate.bulb.lifxAddress.toString('hex');
if (!devices.devices[udn]) return;
bulb = devices.devices[udn].device;
bulb.update(bulb, { power: bulbonoff.on ? 65535 : 0 });
});-
now scroll up to the top of the file where it says
var TBD = exports.Device = function(deviceID, deviceUID, info) {
you will want to capture both info.bulb and info.lx as self.bulb an self.lx, and since bulbs don't emit events, but the lifx object does, you will want to get rid of these lines about
// TBD: invoked by the lower-level bulb driver whenever the bulb changes state. You probably
// have to set the name of the event to whatever the bulb driver emits when its state changes.
self.bulb.on('stateChange', function(state) { self.update(self, state); });
self.update(self, self.bulb.state);
self.changed();instead, we already did the callbacks for this in exports.start() - so what we want to do is to look at
LIFX.prototype.updateand have that update self.status and self.info based on gets passed to it.
next, for the
LIFX.prototype.perform
validate_performfunctions, you will want to handle converting rgb to hsl. look at
lighting-yoctopuce-powercolor.jsto see how that is done.
finally, look for all calls of the form
self.bulb.XYZ(...)in
LIFX.prototype.performsince self.bulb isn't an object, you'll be changing those to self.lifx.XYZ(…)
this may seem a bit daunting, but it's pretty straight-forward. after you've done two of these, you can bang out subsequent drivers very quickly
good luck!
RussNelson
Is there a standard for how internal device state should be stored? I notice that the dev structure has a discovery hash. Should that be only the things reported in the initial discovery? Should I store the current state in a separate subhash in the dev?