0.0.6 • Published 2 years ago

homebridge-wattwatchersamber v0.0.6

Weekly downloads
-
License
MPL-2.0
Repository
bitbucket
Last release
2 years ago

Amber Homebridge Plugin

This is a plugin for Homebridge. It exposes Amber pricing information to HomeKit.

This plugin has been developed by Wattwatchers as a Proof of Concept.

Plugin installation

  1. In Homebridge, select the Plugins tab.
  2. Search for Amber.
  3. Click 'Install' on the Wattwatchers_Amber plugin card.

Plugin configuration

  1. In Homebridge, select the Plugins tab.
  2. Select Settings on the Homebridge Wattwatchers_Amber plugin.
  3. In the configuration form:
    • Enter your Amber API key
    • Select whether or not you want to expose pricing information as a custom made accessory (see next section for details)

Once configured, the plugin will automatically expose pricing information for both electricity imports and exports to HomeKit.

HomeKit native accessory vs. custom accessory

This plugin can expose pricing information to HomeKit in 2 ways:

  1. Through an accessory natively supported by HomeKit and the Home app for iOS. The Home app only supports and displays a specific set of accessories. None of these support pricing information. When opting to expose pricing information as a native accessory, the pricing information will therefore be mapped to an Air Quality Sensor.
  2. Through a custom accessory. When opting to expose pricing information as a custom accessory, it won't be visible in the Home app, it will hoever be visible and usable in the Eve app.

HomeKit native accessory

The HomeKit native accessory exposes:

  • The price in cents/kWh This is mapped to nitrogen density (negative price values are set to 0)

  • The general pricing level This is mapped to air quality. For imports the mapping is as follows:

Amber price levelAir quality
Extremely lowExcellent
Very lowGood
LowGood
NeutralFair
HighInferior
SpikePoor

For exports the mapping is as follows:

Amber price levelAir quality
Extremely lowPoor
Very lowInferior
LowInferior
NeutralFair
HighGood
SpikeExcellent

Custom accessory

The custom accessory exposes:

  • The price in cents/kWh (including negative pricing)
  • The spike status (Yes when prices are currently spiking, No if not)
  • The general pricing level, mapped as follows:
Amber price levelPrice level
Extremely low1
Very low2
Low2
Neutral3
High4
Spike5

Creating automations

The configured switches and sensor will be available within the HomeKit app (when not using a custom accessory) or the Eve app.

Here they can be used to build automations (e.g. turn turn off a device when the cost of imports exceeds a certain level.)

For instructions on how to create automations, visit Apple

0.0.6

2 years ago

0.0.5

2 years ago