PHP Sigfox Client

DeviceMessage extends Model

Table of Contents

LQI_AVERAGE  = 1
AVERAGE
LQI_EXCELLENT  = 3
EXCELLENT
LQI_GOOD  = 2
GOOD
LQI_LIMIT  = 0
LIMIT
LQI_NA  = 4
NA
LQI_REPEATERS_AVERAGE  = 1
AVERAGE
LQI_REPEATERS_EXCELLENT  = 3
EXCELLENT
LQI_REPEATERS_GOOD  = 2
GOOD
LQI_REPEATERS_LIMIT  = 0
LIMIT
LQI_REPEATERS_NA  = 4
NA
$ackRequired  : bool|null
true if an acknowledge is required
$computedLocation  : array<string|int, mixed>|null
$data  : string|null
message content, hex encoded
$device  : CommonDevice|null
Defines a device message
$downlinkAnswerStatus  : DownlinkAnswerStatus|null
the last callback status for this reception
$lqi  : int|null
link quality indicator
$lqiRepeaters  : int|null
link quality indicator for repeated message
$nbFrames  : int|null
nbFrames can be 1 or 3. This value represents an expected number of frames sent by the device.
$rinfos  : array<string|int, mixed>|null
$seqNumber  : int|null
the sequence number for this message, may not be present when device uses VO protocol
$time  : int|null
Timestamp of the message (in milliseconds since the Unix Epoch)
from()  : static
Initializing a model from an array
getAckRequired()  : bool
Getter for ackRequired
getComputedLocation()  : array<string|int, ComputedLocation>
Getter for computedLocation
getData()  : string
Getter for data
getDevice()  : CommonDevice
Getter for device
getDownlinkAnswerStatus()  : DownlinkAnswerStatus
Getter for downlinkAnswerStatus
getLqi()  : int
Getter for lqi
getLqiRepeaters()  : int
Getter for lqiRepeaters
getNbFrames()  : int
Getter for nbFrames
getRinfos()  : array<string|int, Rinfo>
Getter for rinfos
getSeqNumber()  : int
Getter for seqNumber
getTime()  : int
Getter for time
jsonSerialize()  : array<string|int, mixed>
setAckRequired()  : static
Setter for ackRequired
setComputedLocation()  : static
Setter for computedLocation
setData()  : static
Setter for data
setDevice()  : static
Setter for device
setDownlinkAnswerStatus()  : static
Setter for downlinkAnswerStatus
setLqi()  : static
Setter for lqi
setLqiRepeaters()  : static
Setter for lqiRepeaters
setNbFrames()  : static
Setter for nbFrames
setRinfos()  : static
Setter for rinfos
setSeqNumber()  : static
Setter for seqNumber
setTime()  : static
Setter for time

Constants

LQI_REPEATERS_AVERAGE

AVERAGE

public mixed LQI_REPEATERS_AVERAGE = 1

LQI_REPEATERS_EXCELLENT

EXCELLENT

public mixed LQI_REPEATERS_EXCELLENT = 3

LQI_REPEATERS_LIMIT

LIMIT

public mixed LQI_REPEATERS_LIMIT = 0

Properties

$ackRequired

true if an acknowledge is required

protected bool|null $ackRequired = null

$computedLocation

protected array<string|int, mixed>|null $computedLocation = null

$data

message content, hex encoded

protected string|null $data = null

$nbFrames

nbFrames can be 1 or 3. This value represents an expected number of frames sent by the device.

protected int|null $nbFrames = null

$rinfos

protected array<string|int, mixed>|null $rinfos = null

$seqNumber

the sequence number for this message, may not be present when device uses VO protocol

protected int|null $seqNumber = null

$time

Timestamp of the message (in milliseconds since the Unix Epoch)

protected int|null $time = null

Methods

from()

Initializing a model from an array

public static from(array<string|int, mixed> $params) : static
Parameters
$params : array<string|int, mixed>

Pass this parameter if you want to initial property value from an array. See API reference for all property names and types

Tags
throws
DeserializeException

If provided an invalid type to a property

Return values
static —

getAckRequired()

Getter for ackRequired

public getAckRequired() : bool
Return values
bool —

true if an acknowledge is required

getData()

Getter for data

public getData() : string
Return values
string —

message content, hex encoded

getNbFrames()

Getter for nbFrames

public getNbFrames() : int
Return values
int —

nbFrames can be 1 or 3. This value represents an expected number of frames sent by the device.

getRinfos()

Getter for rinfos

public getRinfos() : array<string|int, Rinfo>
Return values
array<string|int, Rinfo> —

getSeqNumber()

Getter for seqNumber

public getSeqNumber() : int
Return values
int —

the sequence number for this message, may not be present when device uses VO protocol

getTime()

Getter for time

public getTime() : int
Return values
int —

Timestamp of the message (in milliseconds since the Unix Epoch)

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Tags
inheritdoc
Return values
array<string|int, mixed> —

setAckRequired()

Setter for ackRequired

public setAckRequired(bool $ackRequired) : static
Parameters
$ackRequired : bool

true if an acknowledge is required

Return values
static —

To use in method chains

setComputedLocation()

Setter for computedLocation

public setComputedLocation(array<string|int, ComputedLocation> $computedLocation) : static
Parameters
$computedLocation : array<string|int, ComputedLocation>
Return values
static —

To use in method chains

setData()

Setter for data

public setData(string $data) : static
Parameters
$data : string

message content, hex encoded

Return values
static —

To use in method chains

setDevice()

Setter for device

public setDevice(CommonDevice $device) : static
Parameters
$device : CommonDevice

Defines a device message

Return values
static —

To use in method chains

setDownlinkAnswerStatus()

Setter for downlinkAnswerStatus

public setDownlinkAnswerStatus(DownlinkAnswerStatus $downlinkAnswerStatus) : static
Parameters
$downlinkAnswerStatus : DownlinkAnswerStatus

the last callback status for this reception

Return values
static —

To use in method chains

setNbFrames()

Setter for nbFrames

public setNbFrames(int $nbFrames) : static
Parameters
$nbFrames : int

nbFrames can be 1 or 3. This value represents an expected number of frames sent by the device.

Return values
static —

To use in method chains

setRinfos()

Setter for rinfos

public setRinfos(array<string|int, Rinfo> $rinfos) : static
Parameters
$rinfos : array<string|int, Rinfo>
Return values
static —

To use in method chains

setSeqNumber()

Setter for seqNumber

public setSeqNumber(int $seqNumber) : static
Parameters
$seqNumber : int

the sequence number for this message, may not be present when device uses VO protocol

Return values
static —

To use in method chains

setTime()

Setter for time

public setTime(int $time) : static
Parameters
$time : int

Timestamp of the message (in milliseconds since the Unix Epoch)

Return values
static —

To use in method chains

Search results