# homebridge-circadian-hue

> This plugin interacts with a Hue Hub instance and slowly synchronizes your color changing lights with the regular naturally occurring color temperature of the sky throughout the day. This gives your environment a more natural feel, with cooler hues during

Latest version **0.9.1** (published 2021-12-28) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install homebridge-circadian-hue
pnpm add homebridge-circadian-hue
yarn add homebridge-circadian-hue
bun add homebridge-circadian-hue
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.1 |
| Published | 2021-12-28 |
| First published | 2021-12-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=14.18.1 |
| Dependencies | 5 |
| Unpacked size | 58.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | sidaf |
| Keywords | homebridge-plugin |

## Links

- npm: https://www.npmjs.com/package/homebridge-circadian-hue
- Repository: https://github.com/sidaf/homebridge-circadian-hue
- Homepage: https://github.com/sidaf/homebridge-circadian-hue#readme
- Issues: https://github.com/sidaf/homebridge-circadian-hue/issues
- npm.io page: https://npm.io/package/homebridge-circadian-hue

## Dependencies (5)

- [suncalc](https://npm.io/package/suncalc.md) ^1.8.0
- [bash-color](https://npm.io/package/bash-color.md) ^0.0.4
- [node-hue-api](https://npm.io/package/node-hue-api.md) ^4.0.8
- [node-persist](https://npm.io/package/node-persist.md) ^0.0.11
- [homebridge-config-ui-x](https://npm.io/package/homebridge-config-ui-x.md) ^4.41.2

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.9.1 (latest) — 2021-12-28
- 0.9.0 — 2021-12-28

## README

# Homebridge Circadian Hue

This plugin interacts with a Hue Hub instance and slowly synchronizes your color changing lights with the regular naturally occurring color temperature of the sky throughout the day. This gives your environment a more natural feel, with cooler hues during the midday and warmer tints near twilight and dawn. Based on the Circadian Lighting Home Assistant Component.

## Configuration

`latitude` value required for working out sun position.

`longitude` value required for working out sun position.

`bridgeAddress` is the IP address of the Hue bridge.

`bridgeUsername` is the username to use to  authenticate to the Hue bridge, see [here](https://developers.meethue.com/develop/get-started-2/) on how to generate a username.

`bridgePollingInterval` is the interval in seconds between collecting information from the Hue bridge.

`maxColortemp` is the maximum colour temperature value that will be set.

`minColortemp` is the minimum colour temperature value that will be set.

`excludeColortemp` is a comma seperated list of lights that will not have their colour temperature changed.

`maxBrightness` is the maximum brightness value that will be set.

`minBrightness` is the minimum brightness value that will be set.

`excludeBrightness` is a comma seperated list of lights that will not have their brightness changed.

`sleepColortemp` is the colour temperature value that will be set when sleep mode is enabled.

`sleepBrightness` is the brightness value that will be set when sleep mode is enabled.

`excludeLights` is a comma seperated list of lights that will be excluded from all changes.

`updateInterval` is the interval in seconds that the setting on a light will be changed.

`excludeManualOverride` is a comma seperated list of lights that will not be manually overridable*.

\* When the plugin detects that the characteristics of a light has significantly changed since it was last checked, the light will be put into "manual mode" and no further brightness or colour temperature changes will be applied by the plugin to this specific light. To reset, and have the light controlled by the plugin again, simply turn the light off and on.

## Example Config

```
...
"accessories": [
...
        {
            "name": "Circadian Hue",
            "accessory": "CircadianHue",
            "latitude": 43.543,
            "longitude": -9.4445,
            "bridgeAddress": "192.168.1.100",
            "bridgeUsername": "kj3riwej3ff43j4fk3j4k4",
            "bridgePollingInterval": 0.5,
            "excludeLights": "8,9,10,12,13,15",
            "updateInterval": 90,
            "maxBrightness": 100,
            "minBrightness": 50,
            "excludeColortemp": "",
            "excludeManualOverride": "1,5,14"
        }
...
    ]
...
```

---
_Source: https://npm.io/package/homebridge-circadian-hue · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
