watsonb8/homebridge-hue-chase
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Wiki Activity

Compare commits

base: watsonb8:master
Branches Tags
watsonb8:master
watsonb8:1.1.3
watsonb8:1.1.2
watsonb8:1.1.1
watsonb8:1.1.0
watsonb8:1.0.0
..
compare: watsonb8:1.0.0
Branches Tags
watsonb8:master
watsonb8:1.1.3
watsonb8:1.1.2
watsonb8:1.1.1
watsonb8:1.1.0
watsonb8:1.0.0

No commits in common. "master" and "1.0.0" have entirely different histories.
master ... 1.0.0

6 changed files with 665 additions and 1253 deletions
Show Stats Expand all files Collapse all files

81
.gitea/workflows/ci.yaml
View File

@ -1,81 +0,0 @@
name: Build homebridge-hue-chase
on:
workflow_dispatch:
push:
branches:
- master
jobs:
build:
name: Build
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
- run: |
npm ci
npm run build
version:
name: Version
outputs:
version: ${{ steps.get_version.outputs.version }}
commit: ${{ steps.get_version.outputs.commit }}
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
- id: get_version
name: Set Version
run: |
export version=`node -p "require('./package.json').version"`
export commit=`echo $GITHUB_SHA | cut -c1-5`
echo "version=$version" >> "$GITHUB_OUTPUT"
echo "commit=$commit" >> "$GITHUB_OUTPUT"
publish_tagged:
name: Publish Latest
needs:
- build
- version
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
- run: npm config set @watsonb8:registry https://gitea.watsonlabs.net/api/packages/watsonb8/npm/
- name: Publish
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
COMMIT: ${{ needs.version.outputs.commit }}
run: |
npm config set -- '//gitea.watsonlabs.net/api/packages/watsonb8/npm/:_authToken' "$NPM_TOKEN"
npm version prerelease --preid="$COMMIT" --git-tag-version=false --allow-same-version=true
npm publish
deploy:
runs-on:
- ubuntu-latest
- internal
name: Deploy
needs: publish_tagged
steps:
- name: Set up SSH key
run: |
mkdir -p ~/.ssh
echo "${{ secrets.ELEVATED_HOMEBRIDGE_SSH_KEY }}" > ~/.ssh/id_rsa
chmod 600 ~/.ssh/id_rsa
ssh-keyscan -p 22 homebridge.me >> ~/.ssh/known_hosts
sudo apt update
sudo apt install sshpass
- name: Remove old Package
run: |
sshpass -p '${{ secrets.ELEVATED_HOMEBRIDGE_PASSWORD }}' ssh -v -o StrictHostKeyChecking=no ${{ secrets.ELEVATED_HOMEBRIDGE_USER }}@${{ secrets.HOMEBRIDGE_HOST }} <<'ENDSSH'
rm -r /home/${{ secrets.HOMEBRIDGE_USER }}/.npm-global/lib/node_modules/@watsonb8/homebridge-hue-chase
ENDSSH
- name: Deploy
run: |
sshpass -p '${{ secrets.ELEVATED_HOMEBRIDGE_PASSWORD }}' ssh -v -o StrictHostKeyChecking=no ${{ secrets.ELEVATED_HOMEBRIDGE_USER }}@${{ secrets.HOMEBRIDGE_HOST }} <<'ENDSSH'
npm install -g @watsonb8/homebridge-hue-chase
ENDSSH

56
README.md
View File

@ -1,56 +0,0 @@
# homebridge-hue-chase
Homebridge-hue-chase is a good way to add a little spice to your home lighting set up. This simple plugin will cycle the colors of any given hue lights.
## Installation
1. Clone the repository by running `git clone ssh://git@thebword.ddns.net:3122/watsonb8/homebridge-hue-chase.git`
2. Run `npm install` to install required modules
3. Run `npm run build` to build the module
4. Run `npm link` or install globally to link this instance to your global homebridge instance
> NOTE: Upon starting this plugin for the first time, you will be asked to press the sync button on your hue bridge
## Configuration
```
{
"platform": "HueChase",
"ipAddress": "example.com",
"userName": "",
"clientKey": "",
"sequences": [
{
"name": "Play Sequence",
"transitionTime": 60000,
"matchAllLights": false,
"colors": ["#00e456", "#21adea", "#f14cfc", "#8c4cfc", "#e40098"],
"lights": ["Play left", "Play right"]
},
]
}
```
#### Platform
- `ipAddress`: The ipaddres or host name of the hue hub
- `userName`: The userName to use when authenticating with the hue hub
> NOTE: This will be visible in the console upon first run of the platform
- `clientKey`: This clientKey to use when authenticating with the hue hub
> NOTE: This will be visible in the console upon first run of the platform
- `sequences`: A list of sequence objects
#### sequences
- `name`: The name of the sequence. This will be the label of the enable switch
- `transitionTime`: The amount of time in milliseconds it will take to transition from one color to the next
- `colors`: A list hex colors
- `lights`: The list of lights to use in the sequence

1176
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

14
package.json
View File

@ -1,13 +1,10 @@
{
"name": "@watsonb8/homebridge-hue-chase",
"version": "1.1.4",
"name": "homebridge-hue-chase",
"version": "1.0.0",
"description": "A Phillips Hue add on for creating chase sequences.",
"main": "bin/index.js",
"publishConfig": {
"registry": "https://gitea.watsonlabs.net"
},
"scripts": {
"build": "tsc --build",
"build": "tsc",
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
@ -31,10 +28,7 @@
"dependencies": {
"@types/node": "^13.1.2",
"@types/node-hue-api": "^2.3.0",
"homebridge": "^0.4.50",
"node-hue-api": "^4.0.0"
},
"devDependencies": {
"homebridge": "^0.4.53",
"typescript": "^4.5.4"
}
}

411
src/chase.ts
View File

@ -9,247 +9,216 @@ let Service: HAPNodeJS.Service;
let Characteristic: HAPNodeJS.Characteristic;
export interface IChaseProps {
name: string;
api: any;
log: any;
homebridge: any;
sequence: ISequence;
hue: Api;
name: string;
api: any;
log: any;
homebridge: any;
sequence: ISequence;
hue: Api
}
export class Chase implements IAccessory {
private _api: any;
private _homebridge: any;
private _log: any = {};
private _api: any;
private _homebridge: any;
private _log: any = {};
//Service fields
private _lightbulbService: HAPNodeJS.Service;
private _infoService: HAPNodeJS.Service;
//Service fields
private _lightbulbService: HAPNodeJS.Service;
private _infoService: HAPNodeJS.Service;
private _sequence: ISequence;
private _sequence: ISequence;
private _isActive: boolean;
private _hue: Api;
private _isActive: boolean;
private _hue: Api;
private _lights: Array<Light> = [];
private _lights: Array<Light> = [];
private _brightness: number = 0;
private _brightness: number = 0;
constructor(props: IChaseProps) {
//Assign class variables
this._log = props.log;
this._api = props.api;
Service = props.api.hap.Service;
Characteristic = props.api.hap.Characteristic;
this.name = props.name;
this._homebridge = props.homebridge;
constructor(props: IChaseProps) {
//Assign class variables
this._log = props.log;
this._api = props.api;
Service = props.api.hap.Service;
Characteristic = props.api.hap.Characteristic;
this.name = props.name;
this._homebridge = props.homebridge;
this._sequence = props.sequence;
this._sequence = props.sequence;
this._isActive = false;
this._hue = props.hue;
this._isActive = false;
this._hue = props.hue;
this.platformAccessory = new this._homebridge.platformAccessory(
this.name,
this.generateUUID(),
this._homebridge.hap.Accessory.Categories.SWITCH
);
this.platformAccessory = new this._homebridge.platformAccessory(this.name, this.generateUUID(), this._homebridge.hap.Accessory.Categories.SWITCH);
//@ts-ignore
this._infoService = new Service.AccessoryInformation();
this._infoService.setCharacteristic(
Characteristic.Manufacturer,
"Brandon Watson"
);
this._infoService.setCharacteristic(Characteristic.Model, "Hue Chase");
this._infoService.setCharacteristic(
Characteristic.SerialNumber,
"123-456-789"
);
this._lightbulbService = new Service.Lightbulb(
this.name,
"lightbulbService"
);
this._lightbulbService
.getCharacteristic(Characteristic.On)
//@ts-ignore
.on("set", this.onPowerSet)
//@ts-ignore
.on("get", this.onPowerGet);
this._lightbulbService
.getCharacteristic(Characteristic.Brightness)
//@ts-ignore
.on("set", this.onBrightnessSet)
//@ts-ignore
.on("get", this.onBrightnessGet);
}
/**
* Required by homebridge.
*/
public name: string;
public platformAccessory: any;
/**
* Called by homebridge to gather services.
*/
public getServices = (): Array<HAPNodeJS.Service> => {
return [this._infoService, this._lightbulbService!];
};
/**
* Handler for switch set event
* @param callback The callback function to call when complete
*/
private onPowerSet = async (
activeState: boolean,
callback: (error?: Error | null | undefined) => void
) => {
if (this._isActive != activeState) {
activeState ? this.chase() : this.stop();
}
return callback();
};
/**
* Handler for switch get event
* @param callback The callback function to call when complete
*/
private onPowerGet = (
callback: (error: Error | null, value: boolean) => void
) => {
return callback(null, this._isActive);
};
private onBrightnessSet = async (
newValue: number,
callback: (error?: Error | null | undefined) => void
) => {
this._brightness = newValue;
const lightState = new LightState();
lightState.on(true).brightness(this._brightness);
await this.setLights(lightState);
return callback();
};
private onBrightnessGet = (
callback: (error: Error | null, value: number) => void
) => {
return callback(null, this._brightness);
};
/**
* Popuplates internal lights array using the configuration values
*/
private getLights = async () => {
//Get lights
const lightPromises: Array<Promise<void>> = this._sequence.lights.map(
async (value: string) => {
//@ts-ignore
const light: Light = await this._hue.lights.getLightByName(value);
this._lights.push(light);
}
);
await Promise.all(lightPromises);
};
this._infoService = new Service.AccessoryInformation();
this._infoService.setCharacteristic(Characteristic.Manufacturer, "Brandon Watson")
this._infoService.setCharacteristic(Characteristic.Model, "Hue Chase")
this._infoService.setCharacteristic(Characteristic.SerialNumber, "123-456-789");
this._lightbulbService = new Service.Lightbulb(
this.name,
'lightbulbService'
)
this.getLights();
this._lightbulbService.getCharacteristic(Characteristic.On)
//@ts-ignore
.on("set", this.onPowerSet)
.on("get", this.onPowerGet);
this._lightbulbService.getCharacteristic(Characteristic.Brightness)
//@ts-ignore
.on("set", this.onBrightnessSet)
.on("get", this.onBrightnessGet);
/**
* Execute chase sequence
*/
private chase = async () => {
if (this._lights.length === 0) {
await this.getLights();
}
const lightState = new LightState();
let idx = 0;
this._isActive = true;
while (this._isActive) {
const rgb = this.hexToRgb(this._sequence.colors[idx]);
lightState
.on(true)
.brightness(this._brightness)
.transitionInMillis(this._sequence.transitionTime)
.rgb(rgb?.red, rgb?.green, rgb?.blue);
await this.setLights(lightState);
/**
* Required by homebridge.
*/
public name: string;
await Sleep(this._sequence.transitionTime);
if (idx == this._sequence.colors.length) {
idx = 0;
} else {
idx++;
}
public platformAccessory: any;
/**
* Called by homebridge to gather services.
*/
public getServices = (): Array<HAPNodeJS.Service> => {
return [this._infoService, this._lightbulbService!];
}
};
/**
* Stop chase sequence
*/
private stopAndSetOff = async () => {
this._isActive = false;
const lightState: LightState = new LightState().off();
await this.setLights(lightState);
};
private stop = () => {
this._isActive = false;
};
private setLights = async (state: LightState) => {
try {
await Promise.all(
this._lights.map(async (value: Light) => {
await this._hue.lights.setLightState(value.id, state);
})
);
} catch (err) {
this._log(`Error while setting brightness: ${err}`);
}
};
/**
* Helper function to convert a hex string to rgb
* @param hex hex string starting with "#"
*/
private hexToRgb = (
hex: string
): { red: number; green: number; blue: number } | null => {
var result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
return result
? {
red: parseInt(result[1], 16),
green: parseInt(result[2], 16),
blue: parseInt(result[3], 16),
/**
* Handler for switch set event
* @param callback The callback function to call when complete
*/
private onPowerSet = async (activeState: boolean, callback: (error?: Error | null | undefined) => void) => {
if (this._isActive != activeState) {
activeState ? this.chase() : this.stopAndSetOff();
}
: null;
};
/**
* Helper function to generate a UUID
*/
private generateUUID(): string {
// Public Domain/MIT
var d = new Date().getTime();
if (
typeof performance !== "undefined" &&
typeof performance.now === "function"
) {
d += performance.now(); //use high-precision timer if available
return callback();
}
/**
* Handler for switch get event
* @param callback The callback function to call when complete
*/
private onPowerGet = (callback: (error: Error | null, value: boolean) => void) => {
return callback(null, this._isActive);
}
private onBrightnessSet = async (newValue: number, callback: (error?: Error | null | undefined) => void) => {
this._brightness = newValue;
const lightState = new LightState();
lightState
.on(true)
.brightness(this._brightness)
await this.setLights(lightState);
return callback();
}
private onBrightnessGet = (callback: (eror: Error | null, value: number) => void) => {
return callback(null, this._brightness);
}
/**
* Popuplates internal lights array using the configuration values
*/
private getLights = async () => {
//Get lights
const lightPromises: Array<Promise<void>> = this._sequence.lights.map(async (value: string) => {
//@ts-ignore
const light: Light = await this._hue.lights.getLightByName(value)
this._lights.push(light);
});
await Promise.all(lightPromises);
}
/**
* Execute chase sequence
*/
private chase = async () => {
if (this._lights.length === 0) {
await this.getLights();
}
const lightState = new LightState();
let idx = 0;
this._isActive = true;
while (this._isActive) {
const rgb = this.hexToRgb(this._sequence.colors[idx])
lightState
.on(true)
.brightness(this._brightness)
.transitionInMillis(this._sequence.transitionTime)
.rgb(rgb?.red, rgb?.green, rgb?.blue);
await this.setLights(lightState);
await Sleep(this._sequence.transitionTime);
if (idx == this._sequence.colors.length) {
idx = 0;
} else {
idx++;
}
}
}
/**
* Stop chase sequence
*/
private stopAndSetOff = async () => {
this._isActive = false;
const lightState: LightState = new LightState()
.off();
await this.setLights(lightState);
}
private stop = () => {
this._isActive = false;
}
private setLights = async (state: LightState) => {
try {
await Promise.all(
this._lights.map(async (value: Light) => {
await this._hue.lights.setLightState(value.id, state);
})
);
} catch (err) {
this._log(`Error while setting brightness: ${err}`)
}
}
/**
* Helper function to convert a hex string to rgb
* @param hex hex string starting with "#"
*/
private hexToRgb = (hex: string): { red: number, green: number, blue: number } | null => {
var result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
return result ? {
red: parseInt(result[1], 16),
green: parseInt(result[2], 16),
blue: parseInt(result[3], 16)
} : null;
}
/**
* Helper function to generate a UUID
*/
private generateUUID(): string { // Public Domain/MIT
var d = new Date().getTime();
if (typeof performance !== 'undefined' && typeof performance.now === 'function') {
d += performance.now(); //use high-precision timer if available
}
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
var r = (d + Math.random() * 16) % 16 | 0;
d = Math.floor(d / 16);
return (c === 'x' ? r : (r & 0x3 | 0x8)).toString(16);
});
}
return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(
/[xy]/g,
function (c) {
var r = (d + Math.random() * 16) % 16 | 0;
d = Math.floor(d / 16);
return (c === "x" ? r : (r & 0x3) | 0x8).toString(16);
}
);
}
}

172
src/index.ts
View File

@ -1,6 +1,6 @@
import { Chase } from "./chase";
import { IConfig, ISequence } from "./models/iConfig";
import { v3 } from "node-hue-api";
import { v3 } from 'node-hue-api';
import LocalBootstrap = require("node-hue-api/lib/api/http/LocalBootstrap");
import Api = require("node-hue-api/lib/api/Api");
import { Sleep } from "./sleep";
@ -13,108 +13,94 @@ let Homebridge: any;
* @param homebridge
*/
export default function (homebridge: any) {
Homebridge = homebridge;
Accessory = homebridge.platformAccessory;
homebridge.registerPlatform(
"homebridge-hue-chase",
"HueChase",
HueChasePlatform,
true
);
}
Homebridge = homebridge;
Accessory = homebridge.platformAccessory;
homebridge.registerPlatform(
'homebridge-hue-chase',
'HueChase',
HueChasePlatform,
true
);
};
class HueChasePlatform {
log: any = {};
api: any;
chaseList: Array<Chase> = [];
config: IConfig;
hue: Api | undefined;
log: any = {};
api: any;
chaseList: Array<Chase> = [];
config: IConfig;
hue: Api | undefined;
constructor(log: any, config: any, api: any) {
this.log = log;
this.api = api;
this.config = config;
this.log("INFO - Registering Hue Chase platform");
this.api.on("didFinishLaunching", this.didFinishLaunching.bind(this));
}
private connectHue = async () => {
if (!this.config) {
return;
constructor(log: any, config: any, api: any) {
this.log = log;
this.api = api;
this.config = config;
this.log('INFO - Registering Hue Chase platform');
this.api.on('didFinishLaunching', this.didFinishLaunching.bind(this));
}
if (this.config.userName && this.config.clientKey) {
this.hue = await v3.api
.createLocal(this.config.ipAddress)
.connect(this.config.userName, this.config.clientKey, null);
this.log("Using existing connection info");
} else {
const unauthenticatedApi = await v3.api
.createLocal(this.config.ipAddress)
.connect(null, null, null);
let createdUser;
let connected = false;
while (!connected) {
try {
this.log("Creating hue user. Push link button");
createdUser = await unauthenticatedApi.users.createUser(
"homebridge",
"HueChase"
);
this.hue = await v3.api
.createLocal(this.config.ipAddress)
.connect(createdUser.username, createdUser.clientKey, null);
this.log("Connected to Hue Bridge");
this.log(
`UserName: ${createdUser.username}, ClientKey: ${createdUser.clientkey}`
);
connected = true;
} catch (err: any) {
if (err.getHueErrorType() === 101) {
this.log(
"The Link button on the bridge was not pressed. Please press the Link button and try again."
);
Sleep(5000);
} else {
this.log(`Unexpected Error: ${err.message}`);
break;
}
private connectHue = async () => {
if (!this.config) {
return;
}
if (this.config.userName && this.config.clientKey) {
this.hue = await v3.api.createLocal(this.config.ipAddress).connect(this.config.userName, this.config.clientKey, null);
this.log("Using existing connection info");
} else {
const unauthenticatedApi = await v3.api.createLocal(this.config.ipAddress).connect(null, null, null);
let createdUser;
let connected = false
while (!connected) {
try {
this.log("Creating hue user. Push link button")
createdUser = await unauthenticatedApi.users.createUser("homebridge", "HueChase");
this.hue = await v3.api.createLocal(this.config.ipAddress).connect(createdUser.username, createdUser.clientKey, null);
this.log("Connected to Hue Bridge");
this.log(`UserName: ${createdUser.username}, ClientKey: ${createdUser.clientkey}`)
connected = true;
} catch (err) {
if (err.getHueErrorType() === 101) {
this.log('The Link button on the bridge was not pressed. Please press the Link button and try again.');
Sleep(5000);
} else {
this.log(`Unexpected Error: ${err.message}`);
break;
}
}
}
}
}
}
};
/**
* Handler for didFinishLaunching
* Happens after constructor
*/
private didFinishLaunching() {
this.log(`INFO - Done registering Hue Chase platform`);
}
/**
* Handler for didFinishLaunching
* Happens after constructor
*/
private didFinishLaunching() {
this.log(`INFO - Done registering Hue Chase platform`);
}
/**
* Called by homebridge to gather accessories.
* @param callback
*/
public accessories = async (
callback: (accessories: Array<Chase>) => void
) => {
//Connect to hue bridge
await this.connectHue();
/**
* Called by homebridge to gather accessories.
* @param callback
*/
public accessories = async (callback: (accessories: Array<Chase>) => void) => {
//Connect to hue bridge
await this.connectHue();
this.config.sequences.forEach((sequence: ISequence) => {
this.chaseList.push(
new Chase({
name: sequence.name,
api: this.api,
log: this.log,
homebridge: Homebridge,
sequence: sequence,
hue: this.hue!,
this.config.sequences.forEach((sequence: ISequence) => {
this.chaseList.push(new Chase({
name: sequence.name,
api: this.api,
log: this.log,
homebridge: Homebridge,
sequence: sequence,
hue: this.hue!,
}))
})
);
});
callback(this.chaseList);
};
callback(this.chaseList);
}
}