PHP Interface Phue\LightInterface

Afficher le fichier Open project: sqmk/phue

Méthodes publiques

Méthode Description
getAlert ( ) : string Get alert
getBrightness ( ) : integer Get brightness
getColorMode ( ) : string Get color mode of light
getColorTemp ( ) : integer Get Color temperature
getEffect ( ) : string Get effect mode
getHue ( ) : integer Get hue
getId ( ) : integer Get light or group Id
getName ( ) : string Get assigned name of light or group
getSaturation ( ) : integer Get saturation
getType ( ) : string Get type
getXY ( ) : array Get XY
isOn ( ) : boolean Is the light or group on?
setAlert ( string $mode = SetLightState::ALERT_LONG_SELECT ) : Phue\LightInterface Set light or group alert
setBrightness ( integer $level = SetLightState::BRIGHTNESS_MAX ) : Phue\LightInterface Set brightness
setColorTemp ( integer $value ) : Phue\LightInterface Set Color temperature
setEffect ( string $mode = SetLightState::EFFECT_NONE ) : Phue\LightInterface Set effect
setHue ( integer $value ) : Phue\LightInterface Set hue
setName ( string $name ) : Phue\LightInterface Set name of light/group
setOn ( boolean $flag = true ) : Phue\LightInterface Set light or group on/off
setSaturation ( integer $value ) : Phue\LightInterface Set saturation
setXY ( float $x, float $y ) : Phue\LightInterface Set XY

Method Details

getAlert() public méthode

Get alert
public getAlert ( ) : string
Résultat string Alert mode

getBrightness() public méthode

Get brightness
public getBrightness ( ) : integer
Résultat integer Brightness level

getColorMode() public méthode

Get color mode of light
public getColorMode ( ) : string
Résultat string Color mode

getColorTemp() public méthode

Get Color temperature
public getColorTemp ( ) : integer
Résultat integer Color temperature value

getEffect() public méthode

Get effect mode
public getEffect ( ) : string
Résultat string effect mode

getHue() public méthode

Get hue
public getHue ( ) : integer
Résultat integer Hue value

getId() public méthode

Get light or group Id
public getId ( ) : integer
Résultat integer Light/Group id

getName() public méthode

Get assigned name of light or group
public getName ( ) : string
Résultat string Name of light/group

getSaturation() public méthode

Get saturation
public getSaturation ( ) : integer
Résultat integer Saturation value

getType() public méthode

Get type
public getType ( ) : string
Résultat string Type

getXY() public méthode

Get XY
public getXY ( ) : array
Résultat array X, Y key/value

isOn() public méthode

Is the light or group on?
public isOn ( ) : boolean
Résultat boolean True if on, false if not

setAlert() public méthode

Set light or group alert
public setAlert ( string $mode = SetLightState::ALERT_LONG_SELECT ) : Phue\LightInterface
$mode string Alert mode
Résultat Phue\LightInterface

setBrightness() public méthode

Set brightness
public setBrightness ( integer $level = SetLightState::BRIGHTNESS_MAX ) : Phue\LightInterface
$level integer Brightness level
Résultat Phue\LightInterface

setColorTemp() public méthode

Set Color temperature
public setColorTemp ( integer $value ) : Phue\LightInterface
$value integer Color temperature value
Résultat Phue\LightInterface

setEffect() public méthode

Set effect
public setEffect ( string $mode = SetLightState::EFFECT_NONE ) : Phue\LightInterface
$mode string Effect mode
Résultat Phue\LightInterface

setHue() public méthode

Set hue
public setHue ( integer $value ) : Phue\LightInterface
$value integer Hue value
Résultat Phue\LightInterface

setName() public méthode

Set name of light/group
public setName ( string $name ) : Phue\LightInterface
$name string
Résultat Phue\LightInterface

setOn() public méthode

Set light or group on/off
public setOn ( boolean $flag = true ) : Phue\LightInterface
$flag boolean True for on, false for off
Résultat Phue\LightInterface

setSaturation() public méthode

Set saturation
public setSaturation ( integer $value ) : Phue\LightInterface
$value integer Saturation value
Résultat Phue\LightInterface

setXY() public méthode

Set XY
public setXY ( float $x, float $y ) : Phue\LightInterface
$x float X value
$y float Y value
Résultat Phue\LightInterface