QSesame: Homebridge plugin (Siri + HomeKit integration)

[steveisles]

@cim @jerming It appears that the API is slowing down in the last 24 hours: there is a much longer delay that doesn’t affect unlocking and locking via the Virtual Station, but does affect locking and unlocking via the API. Note: the API is not broken — but it now always takes several seconds between when an API command is sent before it actually takes effect (last one was about 9 seconds)

Can you guys periodically restart the API server to reduce the impact of the memory leak or whatever is causing the sluggishness?

[steveisles]

As I mentioned in a new thread I started, @cim — it appears the virtual station itself functionality is no longer working, too. It appears the outage/slow-down has gotten more severe/extensive...

[indyhsu]

API isn't working now?

[2017-10-22 20:18:42] [Indy's Home] Set state to unlock
[2017-10-22 20:18:42] [Indy's Home] https://api.candyhouse.co/v1/sesames/xxxxx/control
[2017-10-22 20:18:42] [Indy's Home] unlock
[2017-10-22 20:18:42] [Indy's Home] Error 'null' setting lock state. Response: [object Object]

[cim]

Thanks for reaching out to us! We took a look at your log and you haven't enabled Cloud integration for the API in your Sesame app settings. Please be sure to do so in order to use the API! Please take a look at the instructions here for more info and let us know if you have any further questions. - CANDY HOUSE

[indyhsu]

It's working now. Thank you.

[sam.b.rosen]

Hi,

My QSesame Homebridge plugin crashes every time my devices go to check for an update. I believe this is an error in the actual plugin although no one else seems to be experiencing it! Please see my code below, I'd love to get this working!

Thanks,

Sam

Last login: Tue Nov  7 22:28:04 on ttys000
Church-Server:~ churchserver$ sudo homebridge
Password:
[07/11/2017, 22:44:42] Loaded plugin: homebridge-amazondash
[07/11/2017, 22:44:42] Registering platform 'homebridge-amazondash.AmazonDash'
[07/11/2017, 22:44:42] ---
[07/11/2017, 22:44:42] Loaded plugin: homebridge-broadlink-rm
[07/11/2017, 22:44:42] Registering platform 'homebridge-broadlink-rm.BroadlinkRM'
[07/11/2017, 22:44:42] ---
[07/11/2017, 22:44:42] Loaded plugin: homebridge-cmdswitch2
[07/11/2017, 22:44:42] Registering platform 'homebridge-cmdswitch2.cmdSwitch2'
[07/11/2017, 22:44:42] ---
[07/11/2017, 22:44:42] Loaded plugin: homebridge-dash
[07/11/2017, 22:44:42] Registering accessory 'homebridge-dash.Dash'
[07/11/2017, 22:44:42] ---
[07/11/2017, 22:44:42] Loaded plugin: homebridge-milight
[07/11/2017, 22:44:42] Registering platform 'homebridge-milight.MiLight'
[07/11/2017, 22:44:42] ---
[07/11/2017, 22:44:43] Loaded plugin: homebridge-people
[07/11/2017, 22:44:43] Registering platform 'homebridge-people.People'
[07/11/2017, 22:44:43] Registering accessory 'homebridge-people.PeopleAccessory'
[07/11/2017, 22:44:43] Registering accessory 'homebridge-people.PeopleAllAccessory'
[07/11/2017, 22:44:43] ---
[07/11/2017, 22:44:43] Loaded plugin: homebridge-platform-wemo
[07/11/2017, 22:44:43] Registering platform 'homebridge-platform-wemo.BelkinWeMo'
[07/11/2017, 22:44:43] ---
[07/11/2017, 22:44:43] Loaded plugin: homebridge-qsesame
[07/11/2017, 22:44:43] Registering accessory 'homebridge-qsesame.QSesame'
[07/11/2017, 22:44:43] ---
[07/11/2017, 22:44:43] Loaded plugin: homebridge-statefuldummy
[07/11/2017, 22:44:43] Registering accessory 'homebridge-statefuldummy.StatefulDummySwitch'
[07/11/2017, 22:44:43] ---
[07/11/2017, 22:44:43] Loaded config.json with 1 accessories and 3 platforms.
[07/11/2017, 22:44:43] ---
[07/11/2017, 22:44:43] Loading 3 platforms...
[07/11/2017, 22:44:43] Initializing People platform...
[07/11/2017, 22:44:43] Initializing platform accessory 'Sam'...
[07/11/2017, 22:44:43] Initializing platform accessory 'Stuart'...
[07/11/2017, 22:44:43] Initializing platform accessory 'Rachael'...
[07/11/2017, 22:44:43] Initializing platform accessory 'Anyone'...
[07/11/2017, 22:44:43] Initializing platform accessory 'No One'...
[07/11/2017, 22:44:43] WebHook: Started server on port '51828'.
[07/11/2017, 22:44:43] Initializing cmdSwitch2 platform...
[07/11/2017, 22:44:43] [WeMo Platform] Initializing BelkinWeMo platform...
[07/11/2017, 22:44:43] Loading 1 accessories...
[07/11/2017, 22:44:43] [201FGW] Initializing QSesame accessory...
[07/11/2017, 22:44:43] [201FGW] Attempting to login to CANDY HOUSE...
Load homebridge-amazondash.AmazonDash
Scan this code with your HomeKit App on your iOS device to pair with Homebridge:
                       
    ┌────────────┐     
    │ 031-45-154 │     
    └────────────┘     
                       
[07/11/2017, 22:44:43] Initializing platform accessory 'Kettle'...
[07/11/2017, 22:44:43] Homebridge is running on port 51826.
[07/11/2017, 22:44:43] [WeMo Platform] Online: WeMo Switch [08863BC94214]
[07/11/2017, 22:44:44] [201FGW] Logged in as sam.b.rosen@gmail.com...
[07/11/2017, 22:44:44] [201FGW] Getting the list of Sesames from API...
[07/11/2017, 22:44:45] [201FGW] Got a Sesames JSON from CANDY HOUSE!
[07/11/2017, 22:44:45] [201FGW] Found '201FGW' with device_id F8EC3892C307...
[07/11/2017, 22:44:45] [201FGW] That's the one! Set the lockID...
[07/11/2017, 22:44:45] [201FGW] QSesame is ready to LOCK your world...
[07/11/2017, 22:44:56] Kettle is off.
/usr/local/lib/node_modules/homebridge-qsesame/index.js:138
  	self.log("Getting current state..."); 
  	     ^

TypeError: self.log is not a function
    at QSesame.getState (/usr/local/lib/node_modules/homebridge-qsesame/index.js:138:9)
    at emitThree (events.js:116:13)
    at Characteristic.LockCurrentState.emit (events.js:197:7)
    at Characteristic.LockCurrentState.Characteristic.getValue (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Characteristic.js:142:10)
    at Bridge.<anonymous> (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Accessory.js:706:20)
    at Array.forEach (native)
    at Bridge.Accessory._handleGetCharacteristics (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Accessory.js:670:8)
    at emitMany (events.js:127:13)
    at HAPServer.emit (events.js:204:7)
    at HAPServer._handleCharacteristics (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/HAPServer.js:1002:14)
    at HAPServer.<anonymous> (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/HAPServer.js:220:47)
    at emitNone (events.js:86:13)
    at IncomingMessage.emit (events.js:188:7)
    at endReadableNT (_stream_readable.js:975:12)
    at _combinedTickCallback (internal/process/next_tick.js:80:11)
    at process._tickCallback (internal/process/next_tick.js:104:9)
Church-Server:~ churchserver$

[brendan]

It looks like a global variable conflict on the self object. I used a car called self so I can access “this” in child functions, and it looks like another one of your plugins does as well.

You could try to open my plugin and replace all instances of “self” with banana (or something) and see what happens.

[sam.b.rosen]

Bingo! That seems to have fixed it. Who knew bananas could be so helpful!

[sam.b.rosen]

Hi! So I thought this was working but it is not. The home bridge plugin is authenticating and seeing the lock (as seen in the logs). Except when I push the button in the iOS Home App the state changes in the app but the lock doesn't actually activate. If I then refresh the home app, the lock has actually gone back to it's previous state (as you can see in the logs). I have tried just using the sesame app on 4G (I have a spare iPhone 5C running the Virtual Station app) and this works really well. It is just not working through home bridge.

Church-Server:~ churchserver$ sudo homebridge
Password:
[15/11/2017, 13:03:17] Loaded plugin: homebridge-broadlink-rm
[15/11/2017, 13:03:17] Registering platform 'homebridge-broadlink-rm.BroadlinkRM'
[15/11/2017, 13:03:17] ---
[15/11/2017, 13:03:17] Loaded plugin: homebridge-cmdswitch2
[15/11/2017, 13:03:17] Registering platform 'homebridge-cmdswitch2.cmdSwitch2'
[15/11/2017, 13:03:17] ---
[15/11/2017, 13:03:17] Loaded plugin: homebridge-milight
[15/11/2017, 13:03:17] Registering platform 'homebridge-milight.MiLight'
[15/11/2017, 13:03:17] ---
[15/11/2017, 13:03:19] Loaded plugin: homebridge-people
[15/11/2017, 13:03:19] Registering platform 'homebridge-people.People'
[15/11/2017, 13:03:19] Registering accessory 'homebridge-people.PeopleAccessory'
[15/11/2017, 13:03:19] Registering accessory 'homebridge-people.PeopleAllAccessory'
[15/11/2017, 13:03:19] ---
[15/11/2017, 13:03:20] Loaded plugin: homebridge-platform-wemo
[15/11/2017, 13:03:20] Registering platform 'homebridge-platform-wemo.BelkinWeMo'
[15/11/2017, 13:03:20] ---
[15/11/2017, 13:03:22] Loaded plugin: homebridge-qsesame
[15/11/2017, 13:03:22] Registering accessory 'homebridge-qsesame.QSesame'
[15/11/2017, 13:03:22] ---
[15/11/2017, 13:03:22] Loaded config.json with 1 accessories and 4 platforms.
[15/11/2017, 13:03:22] ---
[15/11/2017, 13:03:22] Loading 4 platforms...
[15/11/2017, 13:03:22] [cmdSwitch2] Initializing cmdSwitch2 platform...
[15/11/2017, 13:03:22] [MiLight] Initializing MiLight platform...
[15/11/2017, 13:03:22] [MiLight] Initializing platform accessory 'Piano Light'...
[15/11/2017, 13:03:22] [MiLight] Initializing platform accessory 'Record Lamp'...
[15/11/2017, 13:03:22] [MiLight] Initializing platform accessory 'Bedroom Lamp'...
[15/11/2017, 13:03:22] [Wemo Switch] Initializing BelkinWeMo platform...
[15/11/2017, 13:03:22] [Broadlink RM] Initializing BroadlinkRM platform...
[15/11/2017, 13:03:22] [Broadlink RM] Initializing platform accessory 'Learn'...
[15/11/2017, 13:03:22] [Broadlink RM] Initializing platform accessory 'Scan Frequency'...
[15/11/2017, 13:03:22] [Broadlink RM] Initializing platform accessory 'Television'...
[15/11/2017, 13:03:22] Loading 1 accessories...
[15/11/2017, 13:03:22] [201FGW] Initializing QSesame accessory...
[15/11/2017, 13:03:22] [201FGW] Attempting to login to CANDY HOUSE...
Scan this code with your HomeKit app on your iOS device to pair with Homebridge:
[15/11/2017, 13:03:22] [cmdSwitch2] Initializing platform accessory 'Kettle'...
[15/11/2017, 13:03:22] Homebridge is running on port 51826.
[15/11/2017, 13:03:22] [Wemo Switch] Online: WeMo Switch [08863BC94214]
Discovered Broadlink RM device at 192.168.0.50 (0d:43:b4:fb:fd:a5)
[15/11/2017, 13:03:23] [201FGW] Logged in as sam.b.rosen@gmail.com...
[15/11/2017, 13:03:23] [201FGW] Getting the list of Sesames from API...
[15/11/2017, 13:03:24] [201FGW] Got a Sesames JSON from CANDY HOUSE!
[15/11/2017, 13:03:24] [201FGW] Found '201FGW' with device_id F8EC3892C307...
[15/11/2017, 13:03:24] [201FGW] That's the one! Set the lockID...
[15/11/2017, 13:03:24] [201FGW] QSesame is ready to LOCK your world...
[15/11/2017, 13:03:24] [Broadlink RM] Television setSwitchState: false
[15/11/2017, 13:03:24] [Broadlink RM] Television setSwitchState: already false
[15/11/2017, 13:03:48] [Broadlink RM] Television getSwitchState: false
[15/11/2017, 13:03:48] [201FGW] Getting current battery...
[15/11/2017, 13:03:48] [201FGW] Getting current state...
[15/11/2017, 13:03:48] [201FGW] Getting current state...
[15/11/2017, 13:03:48] [cmdSwitch2] Kettle is off.
[15/11/2017, 13:03:49] [201FGW] Lock state is true
[15/11/2017, 13:03:49] [201FGW] Lock battery is 97
[15/11/2017, 13:03:49] [201FGW] Lock state is true
[15/11/2017, 13:03:54] [201FGW] Set state to unlock
[15/11/2017, 13:03:54] [201FGW] https://api.candyhouse.co/v1/sesames/F8EC3892C307/control
[15/11/2017, 13:03:54] [201FGW] unlock
[15/11/2017, 13:03:54] [201FGW] State change complete.
[15/11/2017, 13:04:09] [Broadlink RM] Television getSwitchState: false
[15/11/2017, 13:04:09] [201FGW] Getting current battery...
[15/11/2017, 13:04:09] [201FGW] Getting current state...
[15/11/2017, 13:04:09] [201FGW] Getting current state...
[15/11/2017, 13:04:09] [cmdSwitch2] Kettle is off.
[15/11/2017, 13:04:10] [201FGW] Lock state is true
[15/11/2017, 13:04:10] [201FGW] Lock battery is 97
[15/11/2017, 13:04:10] [201FGW] Lock state is true

[ichrisp]

So... this is the best software I have seen in a while. Makes this whole thing worth it!

One problem I have (and I dont know if it's something that's fixable) is that if the unit is manually turned or turned with a key externally, it doesn't update that state in Home. Is that something that would be possible? It also takes an enormously long time to actually do the lock/unlock task. Sometimes 5 mins or more.

[brendan]

Hey @ichrisp glad you like it. I have a new plugin in the works that will auto update the status in HomeKit when the lock is manually turned, or when the state is changed in the app.

I haven’t released it yet because the CANDY HOUSE API does not update consistently. I have another thread open that explains the problem.

The delays you’re experiencing are related to 1) the API being slow or possibly 2) your device having a poor wifi or Bluetooth connection. Check that your Vietual Statoon device or WIFi access point are positioned close to your Sesame and wireless AP.

[ichrisp]

@brendan thanks for the quick response. I’m sure it’s probably the API or the virtual station app. The first few times it connects after the app is relaunched, it’s quick.

As far as the other thread, can you provide a link?

I’m excited to hear you have a new version that does that. Hope it sees the light of day soon!!! Let me know if you need beta testers.

[sam.marchesani]

My Sesame name has an Emoji character. Will this work without changing it? If so is there any specific format for the config file I should enter it as?
Thanks!

[brendan]

That’s a good question. I haven’t tried yet, let me get back to you.

[sam.marchesani]

Mate, don’t worry - it’s worked like a charm. Homebridge can be a bit tricky to set up, so I thought I would ask first in case I spent a day and it’s not compatible.
Worked first try!

[csduncan]

@Brendan - Trying to get a hand with this: https://github.com/quacktacular/homebridge-qsesame/issues/4#issuecomment-367504913

I was trying to figure out what scope issue might be causing this error, but perhaps you know of another reason why I might be getting this error? For some reason, the "self" reference stops working. When I comment out self.log references, it appears to affect anything else using the "self" reference....so the qsesame plugin just doesn't appear to want to work when getting state or battery.

Broadlink RM device at 10.0.1.6 (34:ea:34:4a:25:93) has been re-discovered.
/usr/local/lib/node_modules/homebridge-qsesame/index.js:138
        self.log("Getting current state...");
        ^
TypeError: self.log is not a function
    at QSesame.getState (/usr/local/lib/node_modules/homebridge-qsesame/index.js:138:9)
    at Characteristic.LockCurrentState.emit (events.js:160:13)
    at Characteristic.LockCurrentState.Characteristic.getValue (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Characteristic.js:162:10)
    at Bridge.<anonymous> (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Accessory.js:756:20)
    at Array.forEach (<anonymous>)
    at Bridge.Accessory._handleGetCharacteristics (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Accessory.js:720:8)
    at HAPServer.emit (events.js:160:13)
    at HAPServer._handleCharacteristics (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/HAPServer.js:926:10)
    at HAPServer.<anonymous> (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/HAPServer.js:209:39)
    at IncomingMessage.emit (events.js:160:13)
    at endReadableNT (_stream_readable.js:1101:12)
    at process._tickCallback (internal/process/next_tick.js:152:19)
[2/23/2018, 10:14:42 AM] Loaded plugin: homebridge-broadlink-rm
[2/23/2018, 10:14:42 AM] Registering platform 'homebridge-broadlink-rm.BroadlinkRM'
[2/23/2018, 10:14:42 AM] ---
[2/23/2018, 10:14:42 AM] Loaded plugin: homebridge-config-ui-x
[2/23/2018, 10:14:42 AM] Registering platform 'homebridge-config-ui-x.config'
[2/23/2018, 10:14:42 AM] ---
[2/23/2018, 10:14:42 AM] Loaded plugin: homebridge-qsesame
[2/23/2018, 10:14:42 AM] Registering accessory 'homebridge-qsesame.QSesame'
[2/23/2018, 10:14:42 AM] ---
[2/23/2018, 10:14:42 AM] Loaded config.json with 1 accessories and 2 platforms.
[2/23/2018, 10:14:42 AM] ---
[2/23/2018, 10:14:42 AM] Loading 2 platforms...
[2/23/2018, 10:14:42 AM] [Config] Initializing config platform...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing BroadlinkRM platform...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'Learn'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'A/C Power'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'A/C Speed'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'A/C Mode'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'A/C Temp+'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'A/C Temp-'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'A/C Sleep'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'TV Power'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'TV Vol+'...
[2/23/2018, 10:14:42 AM] [Broadlink RM] Initializing platform accessory 'TV Vol-'...
[2/23/2018, 10:14:42 AM] Loading 1 accessories...
[2/23/2018, 10:14:42 AM] [Lock] Initializing QSesame accessory...
[2/23/2018, 10:14:42 AM] [Lock] Attempting to login to CANDY HOUSE...
[2/23/2018, 10:14:44 AM] [Lock] Getting the list of Sesames from API...
[2/23/2018, 10:14:44 AM] [Lock] Got a Sesames JSON from CANDY HOUSE!
[2/23/2018, 10:14:44 AM] [Lock] Found 'Lock' with device_id F126081EF9F7...
[2/23/2018, 10:14:44 AM] [Lock] That's the one! Set the lockID...
[2/23/2018, 10:14:44 AM] [Lock] QSesame is ready to LOCK your world...

/usr/local/lib/node_modules/homebridge-qsesame/index.js:138
        self.log("Getting current state...");
        ^
TypeError: self.log is not a function
    at QSesame.getState (/usr/local/lib/node_modules/homebridge-qsesame/index.js:138:9)
    at Characteristic.LockCurrentState.emit (events.js:160:13)
    at Characteristic.LockCurrentState.Characteristic.getValue (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Characteristic.js:162:10)
    at Bridge.<anonymous> (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Accessory.js:756:20)
    at Array.forEach (<anonymous>)
    at Bridge.Accessory._handleGetCharacteristics (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/Accessory.js:720:8)
    at HAPServer.emit (events.js:160:13)
    at HAPServer._handleCharacteristics (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/HAPServer.js:926:10)
    at HAPServer.<anonymous> (/usr/local/lib/node_modules/homebridge/node_modules/hap-nodejs/lib/HAPServer.js:209:39)
    at IncomingMessage.emit (events.js:160:13)
    at endReadableNT (_stream_readable.js:1101:12)
    at process._tickCallback (internal/process/next_tick.js:152:19)

Also, I didn't show it in the comments, but homebridge completely crashes because of the "self.log is not a function error".

[csduncan]

And just like that.....I found you answered previously: https://community.candyhouse.co/t/qsesame-homebridge-plugin-siri-homekit-integration/626/54?u=csduncan

Sorry! I've tried it and it appears to work well! Obviously, some delay (sometimes several seconds) and the state of the lock displayed in homekit updates before it actually completes the state change via the API, but in general working pretty well!

I heard from support that V2 of the API is supposed to be a little more performant. That'd be great. I'm also wondering though if you've already given thought to just having Apple handle the local communication? Especially now that software encryption is available and you would necessarily need to release a new product to support the key generation/exchange they require....but rather probably just a firmware update to either the Wifi Access point or the Sesame itself.

[steveisles]

@brendan Out of curiosity, have you tested how the beta version works with the bug-fixes on the V1 API done by @cim @jerming? Are you planning to update the current version under homebridge-qsesame, or will it be a separate homebridge module (the new version?)

Thanks @brendan for all your work on providing Siri+HomeKit implementation. It is an amazing, stable implementation that my family uses daily!

[brendan]

@steveisles glad that it’s been working well for you!

I’ve found that the API has improved somewhat, but unfortunately control actions (unlock and lock) are still very slow or don’t work at all. I feel like this is more of a limitation on the Acess Point side of things though.

I have posted a new version of my plugin on GitHub as homebridge sesame platform, and as it turns out there is now another well written alternative option by another author.

I don’t know that I’ll be putting in much more work unless something changes at Candy House.

[moibensa]

This plugin is actually working great for me. Takes a few seconds to connect but unlocks nearly immediately. Not sure if everyone’s seen this but I’m assuming after they switched to AWS they setup an account called ifttt@candyhouse.co to be assigned to all cloud/api requests. So now for some weird reason, every time I OPEN the home app, whatever the lock was previously on, a new request is sent to do that again. So I’ve gotten hundreds of notifications from Home and the Sesame app that ifttt@candyhouse.co unlocked my Sesame.