https://github.com/jeff-winn/homebridge-example-characteristic

An example for Homebridge demonstrating how to create custom characteristics.
https://github.com/jeff-winn/homebridge-example-characteristic

homebridge homebridge-plugin

Last synced: 13 days ago
JSON representation

An example for Homebridge demonstrating how to create custom characteristics.

• Host: GitHub
• URL: https://github.com/jeff-winn/homebridge-example-characteristic
• Owner: jeff-winn
• License: apache-2.0
• Archived: true
• Created: 2022-11-22T22:34:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-21T19:02:18.000Z (about 2 years ago)
• Last Synced: 2024-09-27T08:20:52.691Z (4 months ago)
• Topics: homebridge, homebridge-plugin
• Language: TypeScript
• Homepage:
• Size: 34.2 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Homebridge Example of Custom Characteristics

This example uses typescript and custom characteristics.

A couple things to mention:

- `Custom Duration` is the custom characteristic exposed by [customDuration.ts](src/characteristics/customDuration.ts)

  - Because Homebridge does not expose the `Characteristic` type from `hap-nodejs` and Homebridge also signals a warning when directly referencing `hap-nodejs` as a dependency you will need to use the api instance passed into your plug-in constructor which references the `hap-nodejs` types.

  - The characteristic can then be attached to any Homebridge service instance.

- The function to attach the code is not required, it is only been separated to isolate construction of the characteristic from the rest of the accessory logic. You could place the contents of the function in the accessory code if you so desire.

- The [platformAccessory.ts](src/platformAccessory.ts#L44) makes use of the `Custom Duration` characteristic and attaches it to the `LightBulb` service.

- Your custom characteristic will **NOT** be visible within the Apple Home app. You will need a 3rd party app (such as Eve or Controller for HomeKit) to view it.

The function below demonstrates the mechanism to attach a custom characteristic:

```typescript

import { API, Characteristic, Formats, Perms, Service, Units } from 'homebridge';

const DISPLAY_NAME = 'Custom Duration';

const UUID = 'b1c8b5a4-ad47-44c4-a50d-18f4bc92737b';

export function attachCustomDurationCharacteristic(target: Service, api: API): Characteristic {

  let result: Characteristic;

  if (target.testCharacteristic(DISPLAY_NAME)) {

    result = target.getCharacteristic(DISPLAY_NAME)!; // Already tested it exists

  } else {

    result = target.addCharacteristic(new api.hap.Characteristic(DISPLAY_NAME, UUID, {

      format: Formats.UINT32,

      perms: [ Perms.PAIRED_READ, Perms.NOTIFY ],

      unit: Units.SECONDS,

    }));

  }

  return result;

}

```

Also, do **NOT** use the UUID mentioned above, you should generate your own.