Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

homebridge-ambient-realtime

valiquette116Apache-2.00.1.11TypeScript support: included

Ambient Weather Realtime API platform plugin for Homebridge.

homebridge-plugin, homekit, ambient, weather, sensor, air quality, co2, leak

readme

homebridge-ambient-realtime

verified-by-homebridge
Ambient platform plugin for Homebridge.

About


Supports Ambiant weather station and additional sensors using Ambiant's realtime API, no polling required, incoming data events are recieved once evey minute.
If you have more than one weather station on account you may filter the weather stations for each home based on the location name assigned in the app for the location you want to display in HomeKit.
Once the plugin starts the last data set Ambient has for your weather station will be shown in the homebridge log as the inital data from the subscribe event. Any item on that list can be configured as a custom sensor using those values as the data points. For details on these values see Ambient device specs.
Note the examples in the sample config below. The actual recieved value will be stored in the sensor as light level value.
I can test agaist the devices I have available, other sensors have only been tested agaist Ambient's API documentaion.
For now custom sensors only trigger when the threshold is exceeded.

Installation

  1. Install this plugin using: npm install -g homebridge-ambient-realtime
  2. Use plugin settings to edit config.json and add your account info.
  3. Run Homebridge
  4. Pair to HomeKit

Config.json example with child bridge

{
    "name": "Ambient",
    "api_app_key": "application key",
    "api_key": "your key goes here",
    "locationAddress": "123 Easy Street",
    "showOutdoor": true,
        "showIndoor": true,
        "showAqin": true,
        "showIndoorAir": false,
        "showOutdoorAir": true,
        "showOtherTemp": false,
        "showLeak": false,
        "sensors": [
            {
                "name": "Wind",
                "dataPoint": "windspeedmph",
                "threshold": 4,
                "type": 0
            },
            {
                "name": "Rain",
                "dataPoint": "eventrainin",
                "threshold": 0,
                "type": 0
            },
            {
                "name": "Lightning",
                "dataPoint": "lightning_hour",
                "threshold": 0,
                "type": 1
            }
        ],
        "showSocketData": false,
    "_bridge": {
        "username": "0E:43:35:74:24:77"
    },
    "platform": "ambient"
}

changelog

Changes

0.1.11

update

  • fixed typo in readme
  • added verified badge
  • bumped dependencies
  • deprecated node 18 support

0.1.10

update

  • fixed an issue with battery status

0.1.9

update

  • fixed an issue where battery status showed for device with no reported status

0.1.8

update

  • fixed bug when no customer sensor are defined

0.1.7

update

  • code cleanup
  • added option to show a sample of recieved data in debug logging
  • fixed bug when setting fault status

0.1.6

refactor

  • fixed crash on load
  • refactored with typescript

0.1.0

Initial

  • HomeKit support for Ambient Weather Sations using Realtime API