New Light State from Philips Hue API

Pipedream makes it easy to connect APIs for Philips Hue and 2,500+ other apps remarkably fast.

Trigger workflow on

New Light State from the Philips Hue API

Next, do this

Connect to 2,500+ APIs using code and no-code building blocks

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Trigger a workflow on New Light State with Philips Hue API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the New Light State trigger
1. Connect your Philips Hue account
2. Configure timer
3. Configure Username
4. Optional- Select a Light ID
5. Optional- Select a Group ID
Add steps to connect to 2,500+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Film with SWAPI - Star Wars API on New Light State from Philips Hue API

Philips Hue + SWAPI - Star Wars

Try it

Send any HTTP Request with HTTP / Webhook API on New Light State from Philips Hue API

Philips Hue + HTTP / Webhook

Try it

Get Backlinks with Ahrefs API on New Light State from Philips Hue API

Philips Hue + Ahrefs

Try it

Execute SQL Query with Snowflake API on New Light State from Philips Hue API

Philips Hue + Snowflake

Try it

[Date/Time] Add/Subtract Time with Formatting API on New Light State from Philips Hue API

Philips Hue + Formatting

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

New Light State on Philips Hue

Description:Emit new event when the state of a light changes (e.g., turned on/off, brightness adjusted, color changed). [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)

Version:0.0.1

Key:philips_hue-new-light-state

View on GitHub

Code#

import common from "../common/base.mjs";
import { ConfigurationError } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "philips_hue-new-light-state",
  name: "New Light State",
  description: "Emit new event when the state of a light changes (e.g., turned on/off, brightness adjusted, color changed). [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    lightId: {
      propDefinition: [
        common.props.philipsHue,
        "lightId",
        (c) => ({
          username: c.username,
        }),
      ],
      optional: true,
    },
    groupId: {
      propDefinition: [
        common.props.philipsHue,
        "groupId",
        (c) => ({
          username: c.username,
        }),
      ],
      optional: true,
    },
  },
  hooks: {
    deploy() {
      if ((!this.lightId && !this.groupId) || (this.lightId && this.groupId)) {
        throw new ConfigurationError("Must specify exactly one of Light ID or Group ID");
      }
    },
  },
  methods: {
    ...common.methods,
    getSummary(item) {
      return `${this.lightId
        ? "Light"
        : "Group"} with ID ${item.id} changed ${item.propertyChanged} state`;
    },
  },
  async run() {
    const previousData = this._getPreviousData();
    const args = {
      username: this.username,
    };
    const { data } = this.lightId
      ? await this.philipsHue.getLight({
        ...args,
        lightId: this.lightId,
      })
      : await this.philipsHue.getGroup({
        ...args,
        groupId: this.groupId,
      });

    for (const item of data) {
      const itemData = {
        on: item?.on,
        brightness: item?.dimming?.brightness,
        color: item?.color?.xy,
      };
      if (
        previousData[item.id]
        && JSON.stringify(previousData[item.id]) === JSON.stringify(itemData)
      ) {
        continue;
      }
      item.propertyChanged = !previousData[item.id] || previousData[item.id].on !== itemData.on
        ? "on/off"
        : previousData[item.id].brightness !== itemData.brightness
          ? "brightness"
          : "color";

      this.emitEvent(item);

      previousData[item.id] = itemData;
    }

    this._setPreviousData(previousData);
  },
  sampleEmit,
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Philips Hue	`philipsHue`	`app`	This component uses the Philips Hue app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Username	`username`	`string`	The username to use. See the documentation for information on how to create an authorized username
Light ID	`lightId`	`string`	Select a value from the drop down menu.
Group ID	`groupId`	`string`	Select a value from the drop down menu.

Authentication#

Philips Hue uses OAuth authentication. When you connect your Philips Hue account, Pipedream will open a popup window where you can sign into Philips Hue and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Philips Hue API.

Pipedream requests the following authorization scopes when you connect your account: