PHP Class Phue\Bridge

Protected Properties

Property	Type	Description
$attributes	stdClass	Bridge attributes
$client	Client	Phue client

Public Methods

Method	Description
__construct ( stdClass $attributes, Client $client )	Construct a Phue Bridge object
arePortalServicesEnabled ( ) : boolean	Are portal services enabled?
enableDhcp ( boolean $state = true ) : self	Enable DHCP
getApiVersion ( ) : string	Get API version
getGateway ( ) : string	Get gateway address
getIpAddress ( ) : string	Get IP Address
getLocalTime ( ) : string	Get local time of bridge
getMacAddress ( ) : string	Get MAC address of bridge
getName ( ) : string	Get name
getNetmask ( ) : string	Get netmask
getPortal ( ) : Portal	Get portal
getProxyAddress ( ) : string	Get proxy address
getProxyPort ( ) : string	Get proxy port
getSoftwareUpdate ( ) : SoftwareUpdate	Get software update
getSoftwareVersion ( ) : string	Get software version
getTimezone ( ) : string	Get timezone
getUtcTime ( ) : string	Get UTC time of bridge
getZigBeeChannel ( ) : integer	Get ZigBee channel
isDhcpEnabled ( ) : boolean	Is DHCP enabled?
isLinkButtonOn ( ) : boolean	Is the link button on?
isPortalConnected ( ) : boolean	Is portal connected?
setGateway ( string $gateway ) : self	Set Gateway
setIpAddress ( string $ipAddress ) : self	Set IP Address
setLinkButtonOn ( boolean $state = true ) : self	Set link button state
setName ( string $name ) : self	Set name of bridge
setNetmask ( string $netmask ) : self	Set Netmask
setProxyAddress ( string $proxyAddress = SetBridgeConfig::DEFAULT_PROXY_ADDRESS ) : self	Set Proxy address
setProxyPort ( $proxyPort = SetBridgeConfig::DEFAULT_PROXY_PORT ) : self	Set Proxy port
setTimezone ( string $timezone ) : self	Set timezone
setZigBeeChannel ( integer $channel ) : self	Set ZigBee channel

Method Details

__construct() public method

Construct a Phue Bridge object

public __construct ( stdClass $attributes, Client $client )
$attributes	stdClass	Bridge attributes
$client	Client	Phue client

arePortalServicesEnabled() public method

Are portal services enabled?

public arePortalServicesEnabled ( ) : boolean
return	boolean	True if services are on, false if not

enableDhcp() public method

Enable DHCP

public enableDhcp ( boolean $state = true ) : self
$state	boolean	True to enable, false to disable
return	self	This object

getApiVersion() public method

Get API version

public getApiVersion ( ) : string
return	string	API Version

getGateway() public method

Get gateway address

public getGateway ( ) : string
return	string	Gateway address

getIpAddress() public method

Get IP Address

public getIpAddress ( ) : string
return	string	IP address

getLocalTime() public method

Get local time of bridge

public getLocalTime ( ) : string
return	string	Date

getMacAddress() public method

Get MAC address of bridge

public getMacAddress ( ) : string
return	string	MAC address

getName() public method

Get name

public getName ( ) : string
return	string	Bridge name

getNetmask() public method

Get netmask

public getNetmask ( ) : string
return	string	Netmask

getPortal() public method

Get portal

public getPortal ( ) : Portal
return	Portal	Portal object

getProxyAddress() public method

Get proxy address

public getProxyAddress ( ) : string
return	string	Proxy address

getProxyPort() public method

Get proxy port

public getProxyPort ( ) : string
return	string	Proxy port

getSoftwareUpdate() public method

Get software update

public getSoftwareUpdate ( ) : SoftwareUpdate
return	SoftwareUpdate	SoftwareUpdate object

getSoftwareVersion() public method

Get software version

public getSoftwareVersion ( ) : string
return	string	Software version

getTimezone() public method

Get timezone

public getTimezone ( ) : string
return	string	Date

getUtcTime() public method

Get UTC time of bridge

public getUtcTime ( ) : string
return	string	Date

getZigBeeChannel() public method

Get ZigBee channel

public getZigBeeChannel ( ) : integer
return	integer	ZygBee Channel

isDhcpEnabled() public method

Is DHCP enabled?

public isDhcpEnabled ( ) : boolean
return	boolean	True if DHCP is enabled, false if not

isLinkButtonOn() public method

Is the link button on?

public isLinkButtonOn ( ) : boolean
return	boolean	True if the link button on, false if not

isPortalConnected() public method

Is portal connected?

public isPortalConnected ( ) : boolean
return	boolean	True if portal is connected, false if not

setGateway() public method

Set Gateway

public setGateway ( string $gateway ) : self
$gateway	string	Gateway
return	self	This object

setIpAddress() public method

Set IP Address

public setIpAddress ( string $ipAddress ) : self
$ipAddress	string	IP Address
return	self	This object

setLinkButtonOn() public method

Set link button state

public setLinkButtonOn ( boolean $state = true ) : self
$state	boolean	True for on, false for off
return	self	This object

setName() public method

Set name of bridge

public setName ( string $name ) : self
$name	string	Name
return	self	This object

setNetmask() public method

Set Netmask

public setNetmask ( string $netmask ) : self
$netmask	string	Netmask
return	self	This object

setProxyAddress() public method

Set Proxy address

public setProxyAddress ( string $proxyAddress = SetBridgeConfig::DEFAULT_PROXY_ADDRESS ) : self
$proxyAddress	string	Proxy address
return	self	This object

setProxyPort() public method

Set Proxy port

public setProxyPort ( $proxyPort = SetBridgeConfig::DEFAULT_PROXY_PORT ) : self
return	self	This object

setTimezone() public method

Set timezone

public setTimezone ( string $timezone ) : self
$timezone	string	Timezone
return	self	This object

setZigBeeChannel() public method

Set ZigBee channel

public setZigBeeChannel ( integer $channel ) : self
$channel	integer	Channel
return	self	This object

Property Details

$attributes protected_oe property

Bridge attributes

protected stdClass $attributes
return	stdClass

$client protected_oe property

Phue client

protected Client,phue $client
return	Client