homebridge-nest-accfactory 0.0.4-a

package/dist/protect.js

@@ -0,0 +1,240 @@
+// Nest Protect
+// Part of homebridge-nest-accfactory
+//
+// Code version 30/8/2024
+// Mark Hulskamp
+'use strict';
+
+// Define our modules
+import HomeKitDevice from './HomeKitDevice.js';
+
+const LOWBATTERYLEVEL = 10; // Low battery level percentage
+
+export default class NestProtect extends HomeKitDevice {
+  batteryService = undefined;
+  smokeService = undefined;
+  motionService = undefined;
+  carbonMonoxideService = undefined;
+
+  constructor(accessory, api, log, eventEmitter, deviceData) {
+    super(accessory, api, log, eventEmitter, deviceData);
+  }
+
+  // Class functions
+  addServices() {
+    // Create extra details for output
+    let postSetupDetails = [];
+
+    // Setup the smoke sensor service if not already present on the accessory
+    this.smokeService = this.accessory.getService(this.hap.Service.SmokeSensor);
+    if (this.smokeService === undefined) {
+      this.smokeService = this.accessory.addService(this.hap.Service.SmokeSensor, '', 1);
+    }
+    if (this.smokeService.testCharacteristic(this.hap.Characteristic.StatusActive) === false) {
+      this.smokeService.addCharacteristic(this.hap.Characteristic.StatusActive);
+    }
+    if (this.smokeService.testCharacteristic(this.hap.Characteristic.StatusFault) === false) {
+      this.smokeService.addCharacteristic(this.hap.Characteristic.StatusFault);
+    }
+    this.smokeService.setPrimaryService();
+
+    // Setup the carbon monoxide service if not already present on the accessory
+    this.carbonMonoxideService = this.accessory.getService(this.hap.Service.CarbonMonoxideSensor);
+    if (this.carbonMonoxideService === undefined) {
+      this.carbonMonoxideService = this.accessory.addService(this.hap.Service.CarbonMonoxideSensor, '', 1);
+    }
+    if (this.carbonMonoxideService.testCharacteristic(this.hap.Characteristic.StatusActive) === false) {
+      this.carbonMonoxideService.addCharacteristic(this.hap.Characteristic.StatusActive);
+    }
+    if (this.carbonMonoxideService.testCharacteristic(this.hap.Characteristic.StatusFault) === false) {
+      this.carbonMonoxideService.addCharacteristic(this.hap.Characteristic.StatusFault);
+    }
+
+    // Setup battery service if not already present on the accessory
+    this.batteryService = this.accessory.getService(this.hap.Service.Battery);
+    if (this.batteryService === undefined) {
+      this.batteryService = this.accessory.addService(this.hap.Service.Battery, '', 1);
+    }
+    this.batteryService.setHiddenService(true);
+
+    // Setup motion service if not already present on the accessory and Nest protect is a wired version
+    if (typeof this.deviceData?.wired_or_battery === 'number' && this.deviceData?.wired_or_battery === 0) {
+      this.motionService = this.accessory.getService(this.hap.Service.MotionSensor);
+      if (this.motionService === undefined) {
+        this.motionService = this.accessory.addService(this.hap.Service.MotionSensor, '', 1);
+      }
+      postSetupDetails.push('With motion sensor');
+    }
+
+    // Setup linkage to EveHome app if configured todo so
+    if (
+      this.deviceData?.eveHistory === true &&
+      this.smokeService !== undefined &&
+      typeof this.historyService?.linkToEveHome === 'function'
+    ) {
+      this.historyService.linkToEveHome(this.smokeService, {
+        description: this.deviceData.description,
+        getcommand: this.#EveHomeGetcommand.bind(this),
+        setcommand: this.#EveHomeSetcommand.bind(this),
+        EveSmoke_lastalarmtest: this.deviceData.latest_alarm_test,
+        EveSmoke_alarmtest: this.deviceData.self_test_in_progress,
+        EveSmoke_heatstatus: this.deviceData.heat_status,
+        EveSmoke_hushedstate: this.deviceData.hushed_state,
+        EveSmoke_statusled: this.deviceData.ntp_green_led,
+        EveSmoke_smoketestpassed: this.deviceData.smoke_test_passed,
+        EveSmoke_heattestpassed: this.deviceData.heat_test_passed,
+      });
+    }
+
+    return postSetupDetails;
+  }
+
+  updateServices(deviceData) {
+    if (
+      typeof deviceData !== 'object' ||
+      this.smokeService === undefined ||
+      this.carbonMonoxideService === undefined ||
+      this.batteryService === undefined
+    ) {
+      return;
+    }
+
+    // Update battery level and status
+    this.batteryService.updateCharacteristic(this.hap.Characteristic.BatteryLevel, deviceData.battery_level);
+    this.batteryService.updateCharacteristic(
+      this.hap.Characteristic.StatusLowBattery,
+      deviceData.battery_level > LOWBATTERYLEVEL && deviceData.battery_health_state === 0
+        ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL
+        : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW,
+    );
+
+    // Update smoke details
+    // If Nest isn't online or removed from base, report in HomeKit
+    this.smokeService.updateCharacteristic(
+      this.hap.Characteristic.StatusActive,
+      deviceData.online === true && deviceData.removed_from_base === false,
+    );
+
+    // General fault if replacement date past or Nest isn't online or removed from base
+    this.smokeService.updateCharacteristic(
+      this.hap.Characteristic.StatusFault,
+      deviceData.online === true && deviceData.removed_from_base === false && Math.floor(Date.now() / 1000) <= deviceData.replacement_date
+        ? this.hap.Characteristic.StatusFault.NO_FAULT
+        : this.hap.Characteristic.StatusFault.GENERAL_FAULT,
+    );
+
+    this.smokeService.updateCharacteristic(
+      this.hap.Characteristic.SmokeDetected,
+      deviceData.smoke_status === 2
+        ? this.hap.Characteristic.SmokeDetected.SMOKE_DETECTED
+        : this.hap.Characteristic.SmokeDetected.SMOKE_NOT_DETECTED,
+    );
+
+    if (deviceData.smoke_status !== 0 && this.deviceData.smoke_status === 0) {
+      this?.log?.warn && this.log.warn('Smoke detected in "%s"', this.deviceData.description);
+    }
+
+    if (deviceData.smoke_status === 0 && this.deviceData.smoke_status !== 0) {
+      this?.log?.info && this.log.info('Smoke is nolonger detected in "%s"', this.deviceData.description);
+    }
+
+    // Update carbon monoxide details
+    // If Nest isn't online or removed from base, report in HomeKit
+    this.carbonMonoxideService.updateCharacteristic(
+      this.hap.Characteristic.StatusActive,
+      deviceData.online === true && deviceData.removed_from_base === false,
+    );
+
+    // General fault if replacement date past or Nest isn't online or removed from base
+    this.carbonMonoxideService.updateCharacteristic(
+      this.hap.Characteristic.StatusFault,
+      deviceData.online === true && deviceData.removed_from_base === false && Math.floor(Date.now() / 1000) <= deviceData.replacement_date
+        ? this.hap.Characteristic.StatusFault.NO_FAULT
+        : this.hap.Characteristic.StatusFault.GENERAL_FAULT,
+    );
+
+    this.carbonMonoxideService.updateCharacteristic(
+      this.hap.Characteristic.CarbonMonoxideDetected,
+      deviceData.co_status === 2
+        ? this.hap.Characteristic.CarbonMonoxideDetected.CO_LEVELS_ABNORMAL
+        : this.hap.Characteristic.CarbonMonoxideDetected.CO_LEVELS_NORMAL,
+    );
+
+    if (deviceData.co_status !== 0 && this.deviceData.co_status === 0) {
+      this?.log?.warn && this.log.warn('Abnormal carbon monoxide levels detected in "%s"', this.deviceData.description);
+    }
+
+    if (deviceData.co_status === 0 && this.deviceData.co_status !== 0) {
+      this?.log?.info && this.log.info('Carbon monoxide levels have returned to normal in "%s"', this.deviceData.description);
+    }
+
+    // Update motion service if present
+    if (this.motionService !== undefined) {
+      // Motion detect if auto_away = false. Not supported on battery powered Nest Protects
+      // If Nest isn't online or removed from base, report in HomeKit
+      this.motionService.updateCharacteristic(
+        this.hap.Characteristic.StatusActive,
+        deviceData.online === true && deviceData.removed_from_base === false,
+      );
+
+      // General fault if replacement date past or Nest isn't online or removed from base
+      this.motionService.updateCharacteristic(
+        this.hap.Characteristic.StatusFault,
+        deviceData.online === true && deviceData.removed_from_base === false && Math.floor(Date.now() / 1000) <= deviceData.replacement_date
+          ? this.hap.Characteristic.StatusFault.NO_FAULT
+          : this.hap.Characteristic.StatusFault.GENERAL_FAULT,
+      );
+
+      this.motionService.updateCharacteristic(this.hap.Characteristic.MotionDetected, deviceData.detected_motion === false);
+
+      // Log motion to history only if changed to previous recording
+      if (deviceData.detected_motion !== this.deviceData.detected_motion && typeof this.historyService?.addHistory === 'function') {
+        this.historyService.addHistory(this.motionService, {
+          time: Math.floor(Date.now() / 1000),
+          status: deviceData.detected_motion === true ? 1 : 0,
+        });
+      }
+    }
+
+    // Notify Eve App of device status changes if linked
+    if (this.deviceData.eveHistory === true && typeof this.historyService?.updateEveHome === 'function') {
+      // Update our internal data with properties Eve will need to process
+      this.deviceData.latest_alarm_test = deviceData.latest_alarm_test;
+      this.deviceData.self_test_in_progress = deviceData.self_test_in_progress;
+      this.deviceData.heat_status = deviceData.heat_status;
+      this.deviceData.ntp_green_led = deviceData.ntp_green_led;
+      this.deviceData.smoke_test_passed = deviceData.smoke_test_passed;
+      this.deviceData.heat_test_passed = deviceData.heat_test_passed;
+      this.historyService.updateEveHome(this.smokeService, this.#EveHomeGetcommand.bind(this));
+    }
+  }
+
+  #EveHomeGetcommand(EveHomeGetData) {
+    // Pass back extra data for Eve Smoke this.hap.CharacteristicEventTypes.GET process command
+    // Data will already be an object, our only job is to add/modify to it
+    if (typeof EveHomeGetData === 'object') {
+      EveHomeGetData.lastalarmtest = this.deviceData.latest_alarm_test;
+      EveHomeGetData.alarmtest = this.deviceData.self_test_in_progress;
+      EveHomeGetData.heatstatus = this.deviceData.heat_status;
+      EveHomeGetData.statusled = this.deviceData.ntp_green_led;
+      EveHomeGetData.smoketestpassed = this.deviceData.smoke_test_passed;
+      EveHomeGetData.heattestpassed = this.deviceData.heat_test_passed;
+      EveHomeGetData.hushedstate = this.deviceData.hushed_state;
+    }
+    return EveHomeGetData;
+  }
+
+  #EveHomeSetcommand(EveHomeSetData) {
+    if (typeof EveHomeSetData !== 'object') {
+      return;
+    }
+
+    if (typeof EveHomeSetData?.alarmtest === 'boolean') {
+      //this.log.info('Eve Smoke Alarm test', (EveHomeSetData.alarmtest === true ? 'start' : 'stop'));
+    }
+    if (typeof EveHomeSetData?.statusled === 'boolean') {
+      this.deviceData.ntp_green_led = EveHomeSetData.statusled; // Do quick status update as setting Nest values does take sometime
+      this.set({ ntp_green_led_enable: EveHomeSetData.statusled });
+    }
+  }
+}

package/dist/protobuf/google/rpc/status.proto

@@ -0,0 +1,91 @@
+// Copyright 2017 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.rpc;
+
+import "google/protobuf/any.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/rpc/status;status";
+option java_multiple_files = true;
+option java_outer_classname = "StatusProto";
+option java_package = "com.google.rpc";
+option objc_class_prefix = "RPC";
+
+// The `Status` type defines a logical error model that is suitable for different
+// programming environments, including REST APIs and RPC APIs. It is used by
+// [gRPC](https://github.com/grpc). The error model is designed to be:
+//
+// - Simple to use and understand for most users
+// - Flexible enough to meet unexpected needs
+//
+// # Overview
+//
+// The `Status` message contains three pieces of data: error code, error message,
+// and error details. The error code should be an enum value of
+// [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed.  The
+// error message should be a developer-facing English message that helps
+// developers *understand* and *resolve* the error. If a localized user-facing
+// error message is needed, put the localized message in the error details or
+// localize it in the client. The optional error details may contain arbitrary
+// information about the error. There is a predefined set of error detail types
+// in the package `google.rpc` that can be used for common error conditions.
+//
+// # Language mapping
+//
+// The `Status` message is the logical representation of the error model, but it
+// is not necessarily the actual wire format. When the `Status` message is
+// exposed in different client libraries and different wire protocols, it can be
+// mapped differently. For example, it will likely be mapped to some exceptions
+// in Java, but more likely mapped to some error codes in C.
+//
+// # Other uses
+//
+// The error model and the `Status` message can be used in a variety of
+// environments, either with or without APIs, to provide a
+// consistent developer experience across different environments.
+//
+// Example uses of this error model include:
+//
+// - Partial errors. If a service needs to return partial errors to the client,
+//     it may embed the `Status` in the normal response to indicate the partial
+//     errors.
+//
+// - Workflow errors. A typical workflow has multiple steps. Each step may
+//     have a `Status` message for error reporting.
+//
+// - Batch operations. If a client uses batch request and batch response, the
+//     `Status` message should be used directly inside batch response, one for
+//     each error sub-response.
+//
+// - Asynchronous operations. If an API call embeds asynchronous operation
+//     results in its response, the status of those operations should be
+//     represented directly using the `Status` message.
+//
+// - Logging. If some API errors are stored in logs, the message `Status` could
+//     be used directly after any stripping needed for security/privacy reasons.
+message Status {
+    // The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+    int32 code = 1;
+
+    // A developer-facing error message, which should be in English. Any
+    // user-facing error message should be localized and sent in the
+    // [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
+    string message = 2;
+
+    // A list of messages that carry the error details.  There is a common set of
+    // message types for APIs to use.
+    repeated google.protobuf.Any details = 3;
+}

package/dist/protobuf/google/rpc/stream_body.proto

@@ -0,0 +1,26 @@
+// Copyright 2018 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.rpc;
+
+import "../../google/rpc/status.proto";
+
+
+message StreamBody {
+    repeated bytes message = 1;
+    google.rpc.Status status = 2;
+    repeated bytes noop = 15;
+}

package/dist/protobuf/google/trait/product/camera.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+import "google/protobuf/duration.proto";
+import "google/protobuf/wrappers.proto";
+
+package google.trait.product.camera;
+
+message FloodlightStateTrait {
+    enum LightState {
+        LIGHT_STATE_UNSPECIFIED = 0;
+        LIGHT_STATE_OFF = 1;
+        LIGHT_STATE_ON = 2;
+    }
+
+    LightState triggeredByMotion = 1;
+    LightState triggeredByEvent = 2;
+    LightState triggeredByLiveView = 3;
+    LightState manuallyTriggered = 4;
+    string associatedFloodlightSerialNumber = 5;
+    string associatedFloodlightFirmwareVersion = 6;
+    LightState currentState = 7;
+}
+
+message FloodlightSettingsTrait {
+    enum MotionTrigger {
+        TRIGGER_UNSPECIFIED = 0;
+        TRIGGER_SENSITIVITY_LOW = 1;
+        TRIGGER_SENSITIVITY_MEDIUM = 2;
+        TRIGGER_SENSITIVITY_HIGH = 3;
+        TRIGGER_SENSITIVITY_OFF = 4;
+    }
+
+    enum OnOffTrigger {
+        TRIGGER_UNSPECIFIED = 0;
+        TRIGGER_OFF = 1;
+        TRIGGER_ON = 2;
+    }
+
+    enum DaylightSensitivity {
+        DAYLIGHT_SENSITIVITY_UNSPECIFIED = 0;
+        DAYLIGHT_SENSITIVITY_DARKER = 1;
+        DAYLIGHT_SENSITIVITY_MEDIUM = 2;
+        DAYLIGHT_SENSITIVITY_BRIGHTER = 3;
+        DAYLIGHT_SENSITIVITY_DARKEST = 4;
+    }
+
+    int32 brightness = 1;
+    MotionTrigger motionTrigger = 2;
+    google.protobuf.Duration timerDuration = 3;
+    OnOffTrigger liveViewingTrigger = 4;
+    DaylightSensitivity daylightSensitivity = 5;
+    OnOffTrigger cameraEventTrigger = 6;
+}

package/dist/protobuf/googlehome/foyer.proto

@@ -0,0 +1,208 @@
+syntax = "proto3";
+
+package google.internal.home.foyer.v1;
+
+message StructuresService {
+  message GetHomeGraphRequest {
+    enum DefaultHiddenDeviceType {
+      DEVICE_TYPE_UNKNOWN = 0;
+      DEVICE_TYPE_TOPAZ = 1;
+      DEVICE_TYPE_KRYPTONITE = 2;
+      DEVICE_TYPE_ANTIGUA = 3;
+      DEVICE_TYPE_NEST_TAG = 4;
+      DEVICE_TYPE_NEST_HEATLINK = 5;
+    }
+
+    string requestId = 3; // 64 hex characters - random is OK
+    int32 unknown1 = 4; // always 1?
+    int32 unknown2 = 5; // always 1?
+    repeated DefaultHiddenDeviceType deviceTypesToUnhideArray = 10;
+  }
+
+  message GetHomeGraphResponse {
+    uint64 responseTimestamp = 1; // Epoch in ms for this response
+    repeated Home homes = 2;
+  }
+
+  message Home {
+    string uuid = 1;
+    string name = 2;
+    Address address = 3;
+    EmailAddress emailAddress = 4;
+    repeated Room rooms = 6;
+    repeated Device devices = 7;
+  }
+
+  message Address {
+    string line1 = 1;
+    string line2 = 2;
+    uint64 timeCreated = 5;
+  }
+
+  message EmailAddress {
+    string value = 1;
+    // field #4 has an unknown varint (1)
+  }
+
+  message Room {
+    string uuid = 1;
+    string name = 3;
+    google.protobuf.StringValue type = 4;
+    repeated Device devices = 5;
+  }
+
+  message Device {
+    message Id {
+      string googleUuid = 1;
+      ThirdPartyId thirdPartyId = 2;
+    }
+
+    message ThirdPartyId {
+      string idType = 1;
+      string id = 2;
+    }
+
+    message OtherThirdPartyIds {
+      repeated ThirdPartyId otherThirdPartyId = 1;
+    }
+
+    Id id = 1;
+    OtherThirdPartyIds otherIds = 39;
+  }
+}
+
+message CameraService {
+  message SendTalkbackRequest {
+    enum TalkbackCommand {
+      COMMAND_UNSPECIFIED = 0;
+      COMMAND_START = 1;
+      COMMAND_STOP = 2;
+    }
+
+    google.protobuf.StringValue googleDeviceId = 1;
+    string streamId = 2;
+    TalkbackCommand command = 3;
+  }
+
+  message SendTalkbackResponse {
+
+  }
+
+  message SendCameraViewIntentRequest {
+    enum ViewIntentCommand {
+      VIEW_INTENT_UNSPECIFIED = 0;
+      VIEW_INTENT_START = 1;
+    }
+
+    message ViewIntentRequest {
+      google.protobuf.StringValue googleDeviceId = 1;
+      ViewIntentCommand command = 2;
+    }
+
+    ViewIntentRequest request = 1;
+  }
+
+  message SendCameraViewIntentResponse {
+
+  }
+
+  message JoinStreamRequest {
+    enum JoinStreamRequest_StreamContext {
+      STREAM_CONTEXT_UNSPECIFIED = 0;
+      STREAM_CONTEXT_DEFAULT = 1;
+      STREAM_CONTEXT_SETUP = 2;
+    }
+
+    enum JoinStreamRequest_EndStreamReason {
+      REASON_UNSPECIFIED = 0;
+      REASON_UNKNOWN = 1;
+      REASON_USER_EXITED_SESSION = 2;
+      REASON_VIDEO_TIME_OUT = 3;
+      REASON_AUDIO_TIME_OUT = 4;
+      REASON_NETWORK_FAILURE = 5;
+      REASON_INCOMPATIBLE_VIDEO_CODEC = 6;
+      REASON_AUDIO_ENCODE_ERROR = 7;
+      REASON_AUDIO_DECODE_ERROR = 8;
+    }
+
+    enum JoinStreamRequest_VideoResolution {
+      VIDEO_RESOLUTION_UNSPECIFIED = 0;
+      VIDEO_RESOLUTION_STANDARD = 1;
+      VIDEO_RESOLUTION_FULL_HIGH = 2;
+    }
+
+    string sdp = 1;
+    string deviceId = 2;
+    string command = 3;
+    string streamId = 4;
+    bool local = 5;
+    JoinStreamRequest_StreamContext streamContext = 6;
+    JoinStreamRequest_EndStreamReason endStreamReason = 7;
+    JoinStreamRequest_VideoResolution requestedVideoResolution = 8;
+  }
+
+  message JoinStreamResponse {
+    enum StreamTerminationStatus {
+      STATUS_UNSPECIFIED = 0;
+      STATUS_STREAM_TERMINATED = 1;
+      STATUS_STREAM_NOT_TERMINATED = 2; // e.g. invalid stream ID specified
+    }
+
+    enum StreamExtensionStatus {
+      STATUS_UNSPECIFIED = 0;
+      STATUS_STREAM_EXTENDED = 1;
+      STATUS_STREAM_NOT_EXTENDED = 2; // e.g. invalid stream ID specified
+    }
+
+    string sdp = 1;
+    string responseType = 2;
+    string streamId = 3;
+    StreamTerminationStatus streamTerminationStatus = 4;
+    StreamExtensionStatus streamExtensionStatus = 5;
+  }
+}
+
+message HomeControlService {
+  message UpdateTraitsRequest {
+    message Request {
+      TargetDevice device = 1;
+      TraitToUpdate trait = 2;
+    }
+
+    message TargetDevice {
+      string googleDeviceId = 1;
+      google.protobuf.StringValue service = 2;
+    }
+
+    message TraitToUpdate {
+      string category = 1;
+      UpdateTrait updateTrait = 2;
+    }
+
+    message UpdateTrait {
+      string name = 1;
+      TraitValue value = 2;
+    }
+
+    message TraitValue {
+      string string = 3;
+      int32 intValue = 4;
+      Properties properties = 5;
+      PropertyArray array = 6;
+    }
+
+    message PropertyArray {
+      repeated TraitValue values = 1;
+    }
+
+    message Properties {
+      repeated UpdateTrait properties = 1;
+    }
+
+    Request request = 1;
+  }
+
+  message UpdateTraitsResponse {
+
+  }
+}

package/dist/protobuf/nest/messages.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+package nest.messages;
+
+message SchemaVersion {
+    uint32 currentVersion = 1;
+    uint32 minCompatVersion = 2;
+}