PHP Class Phue\Bridge

Afficher le fichier Open project: sqmk/phue

Protected Properties

Свойство Type Description
$attributes stdClass Bridge attributes
$client Client Phue client

Méthodes publiques

Méthode 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 méthode

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

arePortalServicesEnabled() public méthode

Are portal services enabled?
public arePortalServicesEnabled ( ) : boolean
Résultat boolean True if services are on, false if not

enableDhcp() public méthode

Enable DHCP
public enableDhcp ( boolean $state = true ) : self
$state boolean True to enable, false to disable
Résultat self This object

getApiVersion() public méthode

Get API version
public getApiVersion ( ) : string
Résultat string API Version

getGateway() public méthode

Get gateway address
public getGateway ( ) : string
Résultat string Gateway address

getIpAddress() public méthode

Get IP Address
public getIpAddress ( ) : string
Résultat string IP address

getLocalTime() public méthode

Get local time of bridge
public getLocalTime ( ) : string
Résultat string Date

getMacAddress() public méthode

Get MAC address of bridge
public getMacAddress ( ) : string
Résultat string MAC address

getName() public méthode

Get name
public getName ( ) : string
Résultat string Bridge name

getNetmask() public méthode

Get netmask
public getNetmask ( ) : string
Résultat string Netmask

getPortal() public méthode

Get portal
public getPortal ( ) : Portal
Résultat Portal Portal object

getProxyAddress() public méthode

Get proxy address
public getProxyAddress ( ) : string
Résultat string Proxy address

getProxyPort() public méthode

Get proxy port
public getProxyPort ( ) : string
Résultat string Proxy port

getSoftwareUpdate() public méthode

Get software update
public getSoftwareUpdate ( ) : SoftwareUpdate
Résultat SoftwareUpdate SoftwareUpdate object

getSoftwareVersion() public méthode

Get software version
public getSoftwareVersion ( ) : string
Résultat string Software version

getTimezone() public méthode

Get timezone
public getTimezone ( ) : string
Résultat string Date

getUtcTime() public méthode

Get UTC time of bridge
public getUtcTime ( ) : string
Résultat string Date

getZigBeeChannel() public méthode

Get ZigBee channel
public getZigBeeChannel ( ) : integer
Résultat integer ZygBee Channel

isDhcpEnabled() public méthode

Is DHCP enabled?
public isDhcpEnabled ( ) : boolean
Résultat boolean True if DHCP is enabled, false if not

isLinkButtonOn() public méthode

Is the link button on?
public isLinkButtonOn ( ) : boolean
Résultat boolean True if the link button on, false if not

isPortalConnected() public méthode

Is portal connected?
public isPortalConnected ( ) : boolean
Résultat boolean True if portal is connected, false if not

setGateway() public méthode

Set Gateway
public setGateway ( string $gateway ) : self
$gateway string Gateway
Résultat self This object

setIpAddress() public méthode

Set IP Address
public setIpAddress ( string $ipAddress ) : self
$ipAddress string IP Address
Résultat self This object

setLinkButtonOn() public méthode

Set link button state
public setLinkButtonOn ( boolean $state = true ) : self
$state boolean True for on, false for off
Résultat self This object

setName() public méthode

Set name of bridge
public setName ( string $name ) : self
$name string Name
Résultat self This object

setNetmask() public méthode

Set Netmask
public setNetmask ( string $netmask ) : self
$netmask string Netmask
Résultat self This object

setProxyAddress() public méthode

Set Proxy address
public setProxyAddress ( string $proxyAddress = SetBridgeConfig::DEFAULT_PROXY_ADDRESS ) : self
$proxyAddress string Proxy address
Résultat self This object

setProxyPort() public méthode

Set Proxy port
public setProxyPort ( $proxyPort = SetBridgeConfig::DEFAULT_PROXY_PORT ) : self
Résultat self This object

setTimezone() public méthode

Set timezone
public setTimezone ( string $timezone ) : self
$timezone string Timezone
Résultat self This object

setZigBeeChannel() public méthode

Set ZigBee channel
public setZigBeeChannel ( integer $channel ) : self
$channel integer Channel
Résultat self This object

Property Details

$attributes protected_oe property

Bridge attributes
protected stdClass $attributes
Résultat stdClass

$client protected_oe property

Phue client
protected Client,phue $client
Résultat Client