zishuo/ring-mqtt
1
0
Fork 0
mirror of https://github.com/tsightler/ring-mqtt.git synced 2025-10-07 01:32:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add chirp tone configuration

Browse Source
This commit is contained in:
tsightler
2023-08-31 11:18:32 -04:00
parent 10bd5d1fb9
commit f88164ee5a
2 changed files with 61 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
devices/binary-sensor.js
View File

@@ -1,11 +1,21 @@
import RingSocketDevice from './base-socket-device.js'
import { RingDeviceType } from 'ring-client-api'
// Helper functions
function chirpToMqttState(chirp) {
return chirp.replace('cowbell', 'dinner-bell')
.replace("-", " ")
.replace(/(^\w{1})|(\s+\w{1})/g, letter => letter.toUpperCase())
}
// Main device class
export default class BinarySensor extends RingSocketDevice {
constructor(deviceInfo) {
super(deviceInfo, 'alarm')
let device_class = false
let bypass_modes = false
this.securityPanel = deviceInfo.securityPanel
// Override icons and and topics
switch (this.device.deviceType) {
@@ -40,6 +50,7 @@ export default class BinarySensor extends RingSocketDevice {
bypass_modes = [ 'Never', 'Always' ]
break;
default:
delete this.securityPanel
if (this.device.name.toLowerCase().includes('motion')) {
this.entityName = 'motion'
this.deviceData.mdl = 'Motion Sensor',
@@ -59,19 +70,36 @@ export default class BinarySensor extends RingSocketDevice {
// Only official Ring sensors can be bypassed
if (bypass_modes) {
const savedState = this.getSavedState()
this.data = {
bypass_mode: savedState?.bypass_mode ? savedState.bypass_mode[0].toUpperCase() + savedState.bypass_mode.slice(1) : 'Never',
published_bypass_mode: false
}
this.entity.bypass_mode = {
component: 'select',
options: bypass_modes
}
this.updateDeviceState()
}
if (this?.securityPanel?.data?.chirps?.[this.device.id]?.type) {
this.data.chirp_tone = chirpToMqttState(this.securityPanel.data.chirps[this.device.id].type)
this.data.published_chirp_tone = false
this.entity.chirp_tone = {
component: 'select',
options: [
'None', 'Ding Dong', 'Harp', 'Navi', 'Wind Chime',
'Dinner Bell', 'Echo', 'Ping Pong', 'Siren', 'Sonar', 'Xylophone'
]
}
this.securityPanel.onData.subscribe(() => {
if (this?.securityPanel?.data?.chirps?.[this.device.id]?.type) {
this.data.chirp_tone = chirpToMqttState(this.securityPanel.data.chirps[this.device.id].type)
}
if (this.isOnline()) {
this.publishChirpToneState()
}
})
}
}
updateDeviceState() {
@@ -86,15 +114,21 @@ export default class BinarySensor extends RingSocketDevice {
const contactState = this.device.data.faulted ? 'ON' : 'OFF'
this.mqttPublish(this.entity[this.entityName].state_topic, contactState)
this.publishBypassModeState(isPublish)
this.publishChirpToneState(isPublish)
this.publishAttributes()
}
publishBypassModeState(isPublish) {
if (this.entity?.bypass_mode) {
if (this.data.bypass_mode !== this.data.published_bypass_mode || isPublish) {
this.data.published_bypass_mode = this.data.bypass_mode.state
this.mqttPublish(this.entity.bypass_mode.state_topic, this.data.bypass_mode)
}
if (this.entity?.bypass_mode && (this.data.bypass_mode !== this.data.published_bypass_mode || isPublish)) {
this.mqttPublish(this.entity.bypass_mode.state_topic, this.data.bypass_mode)
this.data.published_bypass_mode = this.data.bypass_mode
}
}
publishChirpToneState(isPublish) {
if (this.entity?.chirp_tone && (this.data.chirp_tone !== this.data.published_chirp_tone || isPublish)) {
this.mqttPublish(this.entity.chirp_tone.state_topic, this.data.chirp_tone)
this.data.published_chirp_tone = this.data.chirp_tone
}
}
@@ -106,6 +140,11 @@ export default class BinarySensor extends RingSocketDevice {
this.setBypassMode(message)
}
break;
case 'chirp_tone/command':
if (this.entity?.chirp_tone) {
this.setChirpTone(message)
}
break;
default:
this.debug(`Received message to unknown command topic: ${command}`)
}
@@ -124,4 +163,15 @@ export default class BinarySensor extends RingSocketDevice {
this.debug(`Received invalid bypass mode for this sensor: ${message}`)
}
}
async setChirpTone(message) {
this.debug(`Recevied command to set chirp tone ${message}`)
let chirpTone = this.entity.options.find(o => o.toLowerCase() === message.toLowerCase())
if (chirpTone) {
chirpTone = chirpTone.toLowerCase().replace(/\s+/g, "-").replace('dinner-bell', 'cowbell')
this.securityPanel.setInfo({ device: { v1: { chirps: { [this.deviceId]: { type: chirpTone }}}}})
} else {
this.debug('Received command to set unknown chirp tone')
}
}
}