Skip to content

Upgrading from v2 to v3

Dusty Greif edited this page Feb 3, 2021 · 3 revisions

v3 of the plugin includes some great new features, but also includes breaking changes from previous version of the plugin

More Flexibility Via Additional Accessories

In v3, all Rest/Rest+ lights will expose 3 main accessories

  • On / Off - This is the "main" switch to turn the light + sound on and off. It will not impact the individual settings for the light or sound. This is switch is equivalent to tapping the ring on the top of your light.
  • Light - A slider bar for brightness, plus a color picker
  • Audio Track - Shown as a Fan, this allows you to pick from the 12 built in audio tracks, with 0% being "None" and the rest of the tracks activated by setting the Fan to specific speed levels.

These new individual accessories give much finer control over the state of your light, especially from automations. For example, you could now create an automation that sets the track to "None" (fan to 0%) and the light to green. Or if you never change your light/sound settings, you can simply turn the whole unit on/off with the main switch.

The downside to these new accessories is that your current automations will likely need to be redone to use the new individual accessories appropriately.

Other Breaking Changes

  • Removed the showAsSwitch option for Rest lights. Their primary service is now a switch so hopefully this option will no longer be needed
  • Removed alwaysRainbow option. May bring this back in the future if there is interest

Rest Light Accessory Config Changes

For users with the Rest (Bluetooth) light, the config for these lights has changed significantly. Previously, Rest lights were configured as individual accessories with lots of options needed to control them. These lights will now be configured via the HatchBabyRest platform and only require a name and macAddress.

The plugin will automatically update your config file to move these lights. On your first restart after updating, you will likely receive an error that says The requested accessory 'HatchBabyRest' was not registered by any plugin. This is expected, and will go away if you restart homebridge again.

NOTE: All automations connected to Rest lights will be lost in this transition. This is unfortunate, but the new controls available for these lights should hopefully be worth it.

Sample Accessory Config (Old)

{
  "accessories": [
    {
      "accessory": "HatchBabyRest",
      "name": "Kid's Night Light",
      "macAddress": "12:34:56:78:90:AB",
      "volume": 29,
      "audioTrack": 14,
      "color": { "r": 254, "g": 254, "b": 254, "a": 83 },
      "showAsSwitch": false
    }
  ]
}

Sample Platform Config (New)

{
  "platforms": [
    {
      "platform": "HatchBabyRest",
      "restLights": [
        {
          "name": "Kid's Night Light",
          "macAddress": "12:34:56:78:90:AB"
        }
      ]
    }
  ]
}