Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | 1x 1x | /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
*
* light.ts: @switchbot/homebridge-switchbot.
*/
import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
import type { bodyChange, irdevice } from 'node-switchbot'
import type { SwitchBotPlatform } from '../platform.js'
import type { irDevicesConfig, irLightConfig } from '../settings.js'
import { irdeviceBase } from './irdevice.js'
/**
* Platform Accessory
* An instance of this class is created for each accessory your platform registers
* Each accessory may expose multiple services of different service types.
*/
export class Light extends irdeviceBase {
// Services
private LightBulb?: {
Name: CharacteristicValue
Service: Service
On: CharacteristicValue
}
private ProgrammableSwitchOn?: {
Name: CharacteristicValue
Service: Service
ProgrammableSwitchEvent: CharacteristicValue
ProgrammableSwitchOutputState: CharacteristicValue
}
private ProgrammableSwitchOff?: {
Name: CharacteristicValue
Service: Service
ProgrammableSwitchEvent: CharacteristicValue
ProgrammableSwitchOutputState: CharacteristicValue
}
constructor(
readonly platform: SwitchBotPlatform,
accessory: PlatformAccessory,
device: irdevice & irDevicesConfig,
) {
super(platform, accessory, device)
// Set category
accessory.category = this.hap.Categories.LIGHTBULB
if (!(device as irLightConfig).stateless) {
// Initialize LightBulb Service
accessory.context.LightBulb = accessory.context.LightBulb ?? {}
this.LightBulb = {
Name: accessory.displayName,
Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
On: accessory.context.On || false,
}
accessory.context.LightBulb = this.LightBulb as object
this.LightBulb.Service.setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name).getCharacteristic(this.hap.Characteristic.On).onGet(() => {
return this.LightBulb!.On
}).onSet(this.OnSet.bind(this))
} else {
// Initialize ProgrammableSwitchOn Service
accessory.context.ProgrammableSwitchOn = accessory.context.ProgrammableSwitchOn ?? {}
this.ProgrammableSwitchOn = {
Name: `${accessory.displayName} On`,
Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch) ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
ProgrammableSwitchEvent: accessory.context.ProgrammableSwitchEvent ?? this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
ProgrammableSwitchOutputState: accessory.context.ProgrammableSwitchOutputState ?? 0,
}
accessory.context.ProgrammableSwitchOn = this.ProgrammableSwitchOn as object
// Initialize ProgrammableSwitchOn Characteristics
this.ProgrammableSwitchOn?.Service.setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOn.Name).getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
validValueRanges: [0, 0],
minValue: 0,
maxValue: 0,
validValues: [0],
}).onGet(() => {
return this.ProgrammableSwitchOn!.ProgrammableSwitchEvent
})
this.ProgrammableSwitchOn?.Service.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState).onGet(() => {
return this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState
}).onSet(this.ProgrammableSwitchOutputStateSetOn.bind(this))
// Initialize ProgrammableSwitchOff Service
accessory.context.ProgrammableSwitchOff = accessory.context.ProgrammableSwitchOff ?? {}
this.ProgrammableSwitchOff = {
Name: `${accessory.displayName} Off`,
Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch) ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
ProgrammableSwitchEvent: accessory.context.ProgrammableSwitchEvent ?? this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
ProgrammableSwitchOutputState: accessory.context.ProgrammableSwitchOutputState ?? 0,
}
accessory.context.ProgrammableSwitchOff = this.ProgrammableSwitchOff as object
// Initialize ProgrammableSwitchOff Characteristics
this.ProgrammableSwitchOff?.Service.setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOff.Name).getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
validValueRanges: [0, 0],
minValue: 0,
maxValue: 0,
validValues: [0],
}).onGet(() => {
return this.ProgrammableSwitchOff!.ProgrammableSwitchEvent
})
this.ProgrammableSwitchOff?.Service.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState).onGet(() => {
return this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState
}).onSet(this.ProgrammableSwitchOutputStateSetOff.bind(this))
}
}
async OnSet(value: CharacteristicValue): Promise<void> {
this.debugLog(`On: ${value}`)
this.LightBulb!.On = value
if (this.LightBulb?.On) {
const On = true
await this.pushLightOnChanges(On)
} else {
const On = false
await this.pushLightOffChanges(On)
}
/**
* pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
* they are updated, so we are only updating the accessory state after calling the above.
*/
}
async ProgrammableSwitchOutputStateSetOn(value: CharacteristicValue): Promise<void> {
this.debugLog(`On: ${value}`)
this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState = value
if (this.ProgrammableSwitchOn?.ProgrammableSwitchOutputState === 1) {
const On = true
await this.pushLightOnChanges(On)
}
/**
* pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
* they are updated, so we are only updating the accessory state after calling the above.
*/
}
async ProgrammableSwitchOutputStateSetOff(value: CharacteristicValue): Promise<void> {
this.debugLog(`On: ${value}`)
this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState = value
if (this.ProgrammableSwitchOff?.ProgrammableSwitchOutputState === 1) {
const On = false
await this.pushLightOffChanges(On)
}
/**
* pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
* they are updated, so we are only updating the accessory state after calling the above.
*/
}
/**
* Pushes the requested changes to the SwitchBot API
* deviceType commandType Command command parameter Description
* Light - "command" "turnOff" "default" = set to OFF state
* Light - "command" "turnOn" "default" = set to ON state
* Light - "command" "volumeAdd" "default" = volume up
* Light - "command" "volumeSub" "default" = volume down
* Light - "command" "channelAdd" "default" = next channel
* Light - "command" "channelSub" "default" = previous channel
*/
async pushLightOnChanges(On: boolean): Promise<void> {
this.debugLog(`pushLightOnChanges On: ${On}, disablePushOn: ${this.deviceDisablePushOn}`)
if (On === true && this.deviceDisablePushOn === false) {
const commandType: string = await this.commandType()
const command: string = await this.commandOn()
const bodyChange: bodyChange = {
command,
parameter: 'default',
commandType,
}
await this.pushChanges(bodyChange, On)
}
}
async pushLightOffChanges(On: boolean): Promise<void> {
this.debugLog(`pushLightOffChanges On: ${On}, disablePushOff: ${this.deviceDisablePushOff}`)
if (On === false && this.deviceDisablePushOff === false) {
const commandType: string = await this.commandType()
const command: string = await this.commandOff()
const bodyChange: bodyChange = {
command,
parameter: 'default',
commandType,
}
await this.pushChanges(bodyChange, On)
}
}
async pushChanges(bodyChange: any, On: boolean): Promise<void> {
this.debugLog('pushChanges')
if (this.device.connectionType === 'OpenAPI') {
this.infoLog(`Sending request to SwitchBot API, body: ${JSON.stringify(bodyChange)}`)
try {
const response = await this.pushChangeRequest(bodyChange)
const deviceStatus: any = response.body
await this.pushStatusCodes(deviceStatus)
if (await this.successfulStatusCodes(deviceStatus)) {
await this.successfulPushChange(deviceStatus, bodyChange)
this.accessory.context.On = On
await this.updateHomeKitCharacteristics()
} else {
await this.statusCode(deviceStatus.statusCode)
}
} catch (e: any) {
await this.apiError(e)
await this.pushChangeError(e)
}
} else {
this.warnLog(`Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`)
}
}
async updateHomeKitCharacteristics(): Promise<void> {
this.debugLog('updateHomeKitCharacteristics')
if (!(this.device as irLightConfig).stateless && this.LightBulb?.Service) {
// On
await this.updateCharacteristic(this.LightBulb.Service, this.hap.Characteristic.On, this.LightBulb.On, 'On')
} else {
if (this.ProgrammableSwitchOn?.Service) {
// On Stateful Programmable Switch
await this.updateCharacteristic(this.ProgrammableSwitchOn.Service, this.hap.Characteristic.ProgrammableSwitchOutputState, this.ProgrammableSwitchOn.ProgrammableSwitchOutputState, 'ProgrammableSwitchOutputState')
}
if (this.ProgrammableSwitchOff?.Service) {
// Off Stateful Programmable Switch
await this.updateCharacteristic(this.ProgrammableSwitchOff.Service, this.hap.Characteristic.ProgrammableSwitchOutputState, this.ProgrammableSwitchOff.ProgrammableSwitchOutputState, 'ProgrammableSwitchOutputState')
}
}
}
async apiError(e: any): Promise<void> {
if (!(this.device as irLightConfig).stateless) {
this.LightBulb?.Service.updateCharacteristic(this.hap.Characteristic.On, e)
} else {
this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e)
this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e)
this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e)
this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e)
}
}
}
|