---
title: "Philips Hue ZigBee IP Bridge Device Driver"
canonical: "https://docs.cuesystem.com/space/CVCDD/447840268/Philips%20Hue%20ZigBee%20IP%20Bridge%20Device%20Driver"
format: markdown
---
# Properties

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Address | Text | Length = 128 | 192.168.1.100 | IP address of Philips Hue ZigBee IP Bridge. |
| Port | Long | 1 to 65535 | 80 | IP Port number of Philips Hue ZigBee IP Bridge. |
| User Name | Text | Length = 10 to 40 | newdeveloper | User name stored inside the bridge is used for all API calls. |

# Functions

## CreateUser

This function creates a new user. The link button on the bridge must be pressed and this command executed within 30 seconds. Once a new user has been created, the user key is added to a *whitelist*, allowing access to API commands that require a whitelisted user. The *devicetype *parameter contains unique identification of control device. The *newusername *parameter must be set to verify the legitimacy of the control application.

The function returns True on success and False if an error occurs.

#### Syntax

```visualbasic
CreateUser (
  devicetype As Text, 
  newusername As Text) 
As Boolean
```

## DeleteUser

This function deletes the specified user *usernametodelete *from the whitelist. The function returns True on success and False if an error occurs.

#### Syntax

```visualbasic
DeleteUser(usernametodelete As Text) As Boolean
```

## SetState

This function allows turning the light on and off. The *id *parameter represents the unique number assigned to LED light bulb by the Philips Hue Bridge. The *stateon *parameter represents On/Off state of the light. True = On, False = Off. The *transitiontime *parameter means the duration of the transition from the light’s current state to the new state. For this function, there are two predefined constants STATE_ON and STATE_OFF.

The function returns True on success and False if an error occurs.

#### Syntax

```visualbasic
SetState(
  id As Byte, 
  stateon As Boolean, 
  transitiontime As Time) 
As Boolean
```

## GetState

This function sets *isstateon *parameter according to current state of the light identified by parameter *id*.

The function returns True on success and False if an error occurs.

#### Syntax

```visualbasic
GetState(
  id As Byte, 
  ByRef isstateon As Boolean) 
As Boolean
```

## SetBrightness

This function sets *brightness *of the light identified by parameter *id. *The *transitiontime *parameter means the duration of the transition from the light’s current brightness to the new *brightness*.

The function returns True on success and False if an error occurs.

> 📝 Note: The brightness = 0.0 means the minimum the light is capable of but it does not necessarily mean that the light is switched off.

#### Syntax

```visualbasic
SetBrightness(
  id As Byte, 
  brightness As Double, 
  transitiontime As Time) 
As Boolean
```

## GetBrightness

This function returns current brightness of the light identified by parameter *id*.

#### Syntax

```visualbasic
GetBrightness(id As Byte) As Double
```

## SetHue

This function sets *hue *of the light identified by parameter *id. *The *transitiontime *parameter means the duration of the transition from the light’s current hue to the new *hue*.

The function returns True on success and False if an error occurs.

#### Syntax

```visualbasic
SetHue(
  id As Byte, 
  hue As Double, 
  transitiontime As Time) 
As Boolean
```

## GetHue

This function returns current hue of the light identified by parameter *id*.

#### Syntax

```visualbasic
GetHue(id As Byte) As Double
```

## SetSaturation

This function sets *saturation *of the light identified by parameter *id. *The *transitiontime *parameter means the duration of the transition from the light’s current saturation to the new *saturation*.

The function returns True on success and False if an error occurs.

#### Syntax

```visualbasic
SetSaturation(
  id As Byte, 
  saturation As Double, 
  transitiontime As Time) 
As Boolean
```

## GetSaturation

This function returns current saturation of the light identified by parameter *id*.

#### Syntax

```visualbasic
GetSaturation(id As Byte) As Double
```

## SetColorTemperature

This function sets *color temperature *of the light identified by parameter *id. *The *transitiontime *parameter means the duration of the transition from the light’s current color temperature to the new *colortemperature*. Color temperature is in degree Kelvin. Color temperature must be in the range 2000 – 6500 K.

The function returns True on success and False if an error occurs.

#### Syntax

```visualbasic
SetColorTemperature(
  id As Byte, 
  colortemperature As Long, 
  transitiontime As Time) 
As Boolean
```

## GetColorTemperature

This function returns current color temperature of the light identified by parameter *id*.

#### Syntax

```visualbasic
GetColorTemperature(id As Byte) As Long
```

## HSBToColor

This function converts HSB color space attributes to *color *in long number which is in a format compatible with other graphics function. Color opacity is set to the maximum value. HSB stands for *hue*, *saturation*, and *brightness*.

#### Syntax

```visualbasic
HSBToColor(
  hue As Double, 
  saturation As Double, 
  brightness As Double) 
As Long
```

## ColorToHSB

This function converts *color *in long number which is in a format compatible with other graphics function to commonly used HSB color space. Color opacity is ignored. HSB stands for *hue*, *saturation*, and *brightness*.

#### Syntax

```visualbasic
ColorToHSB(
  color As Long, 
  ByRef hue As Double, 
  ByRef saturation As Double, 
  ByRef brightness As Double)
```