open-hue
v1.0.0
Published
See [openhue/openhue-api](https://github.com/openhue/openhue-api)
Downloads
6
Readme
OpenHue TypeScript SDK 1.0.0
Welcome to the OpenHue SDK documentation. This guide will help you get started with integrating and using the OpenHue SDK in your project.
Versions
- API version:
v2 - SDK version:
1.0.0
About the API
Table of Contents
Setup & Configuration
Supported Language Versions
This SDK is compatible with the following versions: TypeScript >= 4.8.4
Installation
To get started with the SDK, we recommend installing using npm:
npm install open-hueAuthentication
API Key Authentication
The OpenHue API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.
Setting the API key
When you initialize the SDK, you can set the API key as follows:
const sdk = new OpenHue({ apiKey: 'YOUR_API_KEY' });If you need to set or update the API key after initializing the SDK, you can use:
const sdk = new OpenHue();
sdk.apiKey = 'YOUR_API_KEY';Services
The SDK provides various services to interact with the API.
| Name | | :------------------------------------------------------------------- | | AuthService | | ResourceService | | DeviceService | | DevicePowerService | | LightService | | LightLevelService | | MotionService | | GroupedLightService | | BridgeService | | BridgeHomeService | | SceneService | | RoomService | | ZoneService | | TemperatureService |
Models
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
| Name | Description |
| :----------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AuthenticateRequest | |
| Response | |
| GetResourcesOkResponse | |
| GetDevicesOkResponse | |
| GetDeviceOkResponse | |
| DevicePut | |
| UpdateDeviceOkResponse | |
| DeleteDeviceOkResponse | |
| GetDevicePowersOkResponse | |
| GetDevicePowerOkResponse | |
| GetLightsOkResponse | |
| GetLightOkResponse | |
| LightPut | |
| UpdateLightOkResponse | |
| GetLightLevelsOkResponse | |
| GetLightLevelOkResponse | |
| LightLevelPut | |
| UpdateLightLevelOkResponse | |
| GetMotionSensorsOkResponse | |
| GetMotionSensorOkResponse | |
| MotionPut | |
| UpdateMotionSensorOkResponse | |
| GetGroupedLightsOkResponse | |
| GetGroupedLightOkResponse | |
| GroupedLightPut | |
| UpdateGroupedLightOkResponse | |
| GetBridgesOkResponse | |
| GetBridgeOkResponse | |
| BridgePut | |
| UpdateBridgeOkResponse | |
| GetBridgeHomesOkResponse | |
| GetBridgeHomeOkResponse | |
| GetScenesOkResponse | |
| ScenePost | |
| CreateSceneOkResponse | |
| GetSceneOkResponse | |
| ScenePut | |
| UpdateSceneOkResponse | |
| DeleteSceneOkResponse | |
| GetRoomsOkResponse | |
| RoomPut | |
| CreateRoomOkResponse | |
| GetRoomOkResponse | |
| UpdateRoomOkResponse | |
| DeleteRoomOkResponse | |
| GetZonesOkResponse | |
| CreateZoneOkResponse | |
| GetZoneOkResponse | |
| UpdateZoneOkResponse | |
| DeleteZoneOkResponse | |
| GetTemperaturesOkResponse | |
| GetTemperatureOkResponse | |
| TemperaturePut | |
| UpdateTemperatureOkResponse | |
| Success | |
| ResponseError | |
| Error | |
| ResourceGet | |
| ResourceGetType | Type of the supported resources |
| ResourceIdentifier | |
| Rtype | The type of the referenced resource |
| DeviceGet | |
| DeviceGetType | |
| ProductData | |
| DeviceGetMetadata | |
| DeviceGetUsertest | |
| ProductArchetype | The default archetype given by manufacturer. Can be changed by user. |
| UsertestStatus | |
| DevicePutType | |
| DevicePutMetadata | |
| Identify | |
| DevicePutUsertest | |
| IdentifyAction | Triggers a visual identification sequence, current implemented as (which can change in the future): Bridge performs Zigbee LED identification cycles for 5 seconds Lights perform one breathe cycle Sensors perform LED identification cycles for 15 seconds |
| DevicePowerGet | |
| PowerState | |
| BatteryState | Status of the power source of a device, only for battery powered devices. - normal – battery level is sufficient - low – battery level low, some features (e.g. software update) might stop working, please change battery soon - critical – battery level critical, device can fail any moment |
| LightGet | |
| LightGetMetadata | Deprecated, use metadata on device level |
| On | |
| LightGetDimming | |
| LightGetColorTemperature | |
| LightGetColor | |
| LightGetDynamics | |
| LightGetSignaling | Feature containing signaling properties. |
| LightGetMode | |
| LightGetGradient | |
| LightGetEffects | Basic feature containing effect properties. |
| LightGetTimedEffects | Basic feature containing timed effect properties. |
| LightGetPowerup | Feature containing properties to configure powerup behaviour of a lightsource. |
| LightArchetype | Light archetype |
| MirekSchema | |
| GamutPosition | CIE XY gamut position |
| Gamut | Color gamut of color bulb. Some bulbs do not properly return the Gamut information. In this case this is not present. |
| GamutType | The gammut types supported by hue – A Gamut of early Philips color-only products – B Limited gamut of first Hue color products – C Richer color gamut of Hue white and color ambiance products – other Color gamut of non-hue products with non-hue gamuts resp w/o gamut |
| SupportedDynamicStatus | Current status of the lamp with dynamics. |
| SupportedSignals | Indicates which signal is currently active. |
| Color | |
| SupportedGradientMode | Mode in which the points are currently being deployed. If not provided during PUT/POST it will be defaulted to interpolated_palette |
| SupportedEffects | |
| SupportedTimedEffects | Current status values the light is in regarding timed effects |
| PowerupPreset1 | When setting the custom preset the additional properties can be set. For all other presets, no other properties can be included.