\App\IqrfNetModule\ModelsStandardLightManager

Tool for managing standard lights in the IQMESH network

Summary

Methods
Properties
Constants
__construct()
enumerate()
setPower()
getPower()
incrementPower()
decrementPower()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(\App\IqrfNetModule\Models\ApiRequest  request, \App\IqrfNetModule\Models\WebSocketClient  wsClient) : 

Constructor

Parameters

\App\IqrfNetModule\Models\ApiRequest request

JSON API request

\App\IqrfNetModule\Models\WebSocketClient wsClient

WebSocket client

Returns

enumerate()

enumerate(  address) : mixed||string|int

Enumerates a IQRF Standard light device

Parameters

address

Network device address

Throws

\App\IqrfNetModule\Models\DpaErrorException
\App\IqrfNetModule\Models\EmptyResponseException
\App\IqrfNetModule\Models\JsonException
\App\IqrfNetModule\Models\UserErrorException

Returns

mixed||string|int —

API request and response

setPower()

setPower(  address, \App\IqrfNetModule\Models\StandardLight||string|int  lights) : mixed||string|int

Sets a power of the lights

Parameters

address

Network device address

\App\IqrfNetModule\Models\StandardLight||string|int lights

Array of IQRF Standard light entities

Throws

\App\IqrfNetModule\Models\DpaErrorException
\App\IqrfNetModule\Models\EmptyResponseException
\App\IqrfNetModule\Models\JsonException
\App\IqrfNetModule\Models\UserErrorException

Returns

mixed||string|int —

API request and response

getPower()

getPower(  address, \App\IqrfNetModule\Models\StandardLight||string|int  lights) : mixed||string|int

Gets power of the lights

Parameters

address

Network device address

\App\IqrfNetModule\Models\StandardLight||string|int lights

Array of IQRF Standard light entities

Throws

\App\IqrfNetModule\Models\DpaErrorException
\App\IqrfNetModule\Models\EmptyResponseException
\App\IqrfNetModule\Models\JsonException
\App\IqrfNetModule\Models\UserErrorException

Returns

mixed||string|int —

API request and response

incrementPower()

incrementPower(  address, \App\IqrfNetModule\Models\StandardLight||string|int  lights) : mixed||string|int

Increments power of the lights

Parameters

address

Network device address

\App\IqrfNetModule\Models\StandardLight||string|int lights

Array of IQRF Standard light entities

Throws

\App\IqrfNetModule\Models\DpaErrorException
\App\IqrfNetModule\Models\EmptyResponseException
\App\IqrfNetModule\Models\JsonException
\App\IqrfNetModule\Models\UserErrorException

Returns

mixed||string|int —

API request and response

decrementPower()

decrementPower(  address, \App\IqrfNetModule\Models\StandardLight||string|int  lights) : mixed||string|int

Decrements power of the lights

Parameters

address

Network device address

\App\IqrfNetModule\Models\StandardLight||string|int lights

Array of IQRF Standard light entities

Throws

\App\IqrfNetModule\Models\DpaErrorException
\App\IqrfNetModule\Models\EmptyResponseException
\App\IqrfNetModule\Models\JsonException
\App\IqrfNetModule\Models\UserErrorException

Returns

mixed||string|int —

API request and response