PHP Класс Phue\Bridge

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$attributes stdClass Bridge attributes
$client Client Phue client

Открытые методы

Метод Описание
__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

Описание методов

__construct() публичный Метод

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

arePortalServicesEnabled() публичный Метод

Are portal services enabled?
public arePortalServicesEnabled ( ) : boolean
Результат boolean True if services are on, false if not

enableDhcp() публичный Метод

Enable DHCP
public enableDhcp ( boolean $state = true ) : self
$state boolean True to enable, false to disable
Результат self This object

getApiVersion() публичный Метод

Get API version
public getApiVersion ( ) : string
Результат string API Version

getGateway() публичный Метод

Get gateway address
public getGateway ( ) : string
Результат string Gateway address

getIpAddress() публичный Метод

Get IP Address
public getIpAddress ( ) : string
Результат string IP address

getLocalTime() публичный Метод

Get local time of bridge
public getLocalTime ( ) : string
Результат string Date

getMacAddress() публичный Метод

Get MAC address of bridge
public getMacAddress ( ) : string
Результат string MAC address

getName() публичный Метод

Get name
public getName ( ) : string
Результат string Bridge name

getNetmask() публичный Метод

Get netmask
public getNetmask ( ) : string
Результат string Netmask

getPortal() публичный Метод

Get portal
public getPortal ( ) : Portal
Результат Portal Portal object

getProxyAddress() публичный Метод

Get proxy address
public getProxyAddress ( ) : string
Результат string Proxy address

getProxyPort() публичный Метод

Get proxy port
public getProxyPort ( ) : string
Результат string Proxy port

getSoftwareUpdate() публичный Метод

Get software update
public getSoftwareUpdate ( ) : SoftwareUpdate
Результат SoftwareUpdate SoftwareUpdate object

getSoftwareVersion() публичный Метод

Get software version
public getSoftwareVersion ( ) : string
Результат string Software version

getTimezone() публичный Метод

Get timezone
public getTimezone ( ) : string
Результат string Date

getUtcTime() публичный Метод

Get UTC time of bridge
public getUtcTime ( ) : string
Результат string Date

getZigBeeChannel() публичный Метод

Get ZigBee channel
public getZigBeeChannel ( ) : integer
Результат integer ZygBee Channel

isDhcpEnabled() публичный Метод

Is DHCP enabled?
public isDhcpEnabled ( ) : boolean
Результат boolean True if DHCP is enabled, false if not

isLinkButtonOn() публичный Метод

Is the link button on?
public isLinkButtonOn ( ) : boolean
Результат boolean True if the link button on, false if not

isPortalConnected() публичный Метод

Is portal connected?
public isPortalConnected ( ) : boolean
Результат boolean True if portal is connected, false if not

setGateway() публичный Метод

Set Gateway
public setGateway ( string $gateway ) : self
$gateway string Gateway
Результат self This object

setIpAddress() публичный Метод

Set IP Address
public setIpAddress ( string $ipAddress ) : self
$ipAddress string IP Address
Результат self This object

setLinkButtonOn() публичный Метод

Set link button state
public setLinkButtonOn ( boolean $state = true ) : self
$state boolean True for on, false for off
Результат self This object

setName() публичный Метод

Set name of bridge
public setName ( string $name ) : self
$name string Name
Результат self This object

setNetmask() публичный Метод

Set Netmask
public setNetmask ( string $netmask ) : self
$netmask string Netmask
Результат self This object

setProxyAddress() публичный Метод

Set Proxy address
public setProxyAddress ( string $proxyAddress = SetBridgeConfig::DEFAULT_PROXY_ADDRESS ) : self
$proxyAddress string Proxy address
Результат self This object

setProxyPort() публичный Метод

Set Proxy port
public setProxyPort ( $proxyPort = SetBridgeConfig::DEFAULT_PROXY_PORT ) : self
Результат self This object

setTimezone() публичный Метод

Set timezone
public setTimezone ( string $timezone ) : self
$timezone string Timezone
Результат self This object

setZigBeeChannel() публичный Метод

Set ZigBee channel
public setZigBeeChannel ( integer $channel ) : self
$channel integer Channel
Результат self This object

Описание свойств

$attributes защищенное свойство

Bridge attributes
protected stdClass $attributes
Результат stdClass

$client защищенное свойство

Phue client
protected Client,phue $client
Результат Client