hb-nb-tools
Version:
Homebridge NB Tools
236 lines (210 loc) • 6.31 kB
JavaScript
// hb-nb-tools/lib/NbClient.js
// Copyright © 2020-2026 Erik Baauw. All rights reserved.
//
// Homebridge NB Tools.
import { createHash, randomInt } from 'node:crypto'
import tweetnacl from 'tweetnacl'
import { toHexString } from 'hb-lib-tools'
import { HttpClient } from 'hb-lib-tools/HttpClient'
import { JsonFormatter } from 'hb-lib-tools/JsonFormatter'
import { OptionParser } from 'hb-lib-tools/OptionParser'
const { secretbox, randomBytes } = tweetnacl
/** Nuki bridge HTTP API client.
* <br>See {@link NbClient}.
* @name NbClient
* @type {Class}
* @memberof module:hb-nb-tools
*/
/** Nuki bridge HTTP API client.
*
* See the [Nuki bridge HTTP API](https://developer.nuki.io/page/nuki-bridge-http-api-1-13/4)
* documentation for a better understanding of the API.
* @extends HttpClient
*/
class NbClient extends HttpClient {
static get DeviceTypes () {
return {
SMARTLOCK: 0,
OPENER: 2,
SMARTDOOR: 3,
SMARTLOCK3: 4
}
}
static get LockStates () {
return {
UNCALIBRATED: 0,
LOCKED: 1,
UNLOCKING: 2,
UNLOCKED: 3,
LOCKING: 4,
UNLATCHED: 5,
UNLOCKED_LOCK_N_GO: 6,
UNLATCHING: 7,
MOTOR_BLOCKED: 254,
UNDEFINED: 255
}
}
static get DoorSensorStates () {
return {
DEACTIVATED: 0,
CLOSED: 2,
OPEN: 3,
UNKNOWN: 4,
CALIBRATING: 5
}
}
static get LockActions () {
return {
UNLOCK: 1,
LOCK: 2,
UNLATCH: 3,
LOCK_N_GO: 4,
LOCK_N_GO_WITH_UNLATCH: 5
}
}
static get OpenerModes () {
return {
DOOR_MODE: 2,
CONTINUOUS_MODE: 3
}
}
static get OpenerStates () {
return {
UNTRAINED: 0,
ONLINE: 1,
RTO_ACTIVE: 3,
OPEN: 5,
OPENING: 7,
BOOT_RUN: 253,
UNDEFINED: 255
}
}
static get OpenerActions () {
return {
ACTIVATE_RTO: 1,
DEACTIVATE_RTO: 2,
OPEN: 3,
ACTIVATE_CM: 4,
DEACTIVATE_CM: 5
}
}
static modelName (deviceType, firmware) {
switch (deviceType) {
case NbClient.DeviceTypes.SMARTLOCK:
case NbClient.DeviceTypes.SMARTLOCK3:
return 'Smart Lock ' + firmware[0]
case NbClient.DeviceTypes.OPENER:
return 'Opener'
case NbClient.DeviceTypes.SMARTDOOR:
return 'Smart Door'
}
}
constructor (params = {}) {
const _params = {
encryption: 'encryptedToken',
port: 8080,
timeout: 5
}
const optionParser = new OptionParser(_params)
optionParser
.enumKey('encryption')
.enumKeyValue('encryption', 'none')
.enumKeyValue('encryption', 'hashedToken')
.enumKeyValue('encryption', 'encryptedToken')
.instanceKey('logger')
.hostKey('host')
.intKey('timeout', 1, 60)
.stringKey('token')
.parse(params)
super({
host: _params.hostname + ':' + _params.port,
json: true,
logger: _params.logger,
keepAlive: true,
maxSockets: 1,
timeout: _params.timeout
})
this._params = _params
this._jsonFormatter = new JsonFormatter()
}
get id () { return this._params.id }
get name () { return this._params.id == null ? this._params.hostname : 'Nuki Bridge ' + this._params.id }
get encryption () { return this._params.encryption }
get firmware () { return this._params.firmware }
get token () { return this._params.token }
async auth () {
const response = await this._get('/auth')
if (response.body.success) {
this._params.token = response.body.token
return response.body.token
}
return null
}
async info () { return this._get('/info') }
async list () { return this._get('/list') }
async log () { return this._get('/log') }
async reboot () { return this._get('/reboot') }
async fwupdate () { return this._get('/fwupdate') }
async lockState (nukiId, deviceType) {
return this._get('/lockState', { nukiId, deviceType })
}
async lock (nukiId, deviceType) {
return this._get('/lock', { nukiId, deviceType })
}
async unlock (nukiId, deviceType) {
return this._get('/unlock', { nukiId, deviceType })
}
async lockAction (nukiId, deviceType, action) {
return this._get(
'/lockAction', { nukiId, deviceType, action }
)
}
async init () {
const response = await this.info()
this._params.id = toHexString(response.body.ids.serverId)
this._params.firmware = response.body.versions.firmwareVersion
}
async callbackAdd (url) {
url = OptionParser.toString('url', url, true)
return this._get('/callback/add', { url: encodeURIComponent(url) })
}
async callbackList () { return this._get('/callback/list') }
async callbackRemove (id) { return this._get('/callback/remove', { id }) }
async _get (resource, params = {}) {
// Append parameters
let separator = '?'
for (const param in params) {
resource += separator + param + '=' + params[param]
separator = '&'
}
let suffix = ''
if (resource !== '/auth') {
if (this._params.encryption === 'none') {
suffix = separator + 'token=' + this._params.token
} else {
const date = new Date().toISOString()
const ts = date.slice(0, 19) + 'Z'
if (this._params.encryption === 'encryptedToken') {
if (this._key == null) {
const hash = createHash('sha256')
hash.update(this._params.token)
this._key = hash.digest()
}
const rnr = randomInt(10000)
const nonce = Buffer.from(randomBytes(secretbox.nonceLength))
const message = Buffer.from([ts, rnr].join(','), 'utf-8')
const ctoken = Buffer.from(secretbox(message, nonce, this._key))
suffix = separator + 'ctoken=' + ctoken.toString('hex') + '&nonce=' + nonce.toString('hex')
} else if (this._params.encryption === 'hashedToken') { // deprecated
const hash = createHash('sha256')
const rnr = Number(date[18] + date.slice(20, 23))
hash.update([ts, rnr, this._params.token].join(','))
suffix = separator + 'ts=' + ts + '&rnr=' + rnr +
'&hash=' + hash.digest('hex')
}
}
}
return super.get(resource, undefined, suffix)
}
}
export { NbClient }