PHP Sigfox Client

Device extends CommonDevice

Defines the device's properties

Table of Contents

AUTOMATIC_RENEWAL_STATUS_ALLOWED  = 0
ALLOWED
AUTOMATIC_RENEWAL_STATUS_ENDED  = 3
ENDED
AUTOMATIC_RENEWAL_STATUS_NOT_ALLOWED  = 1
NOT_ALLOWED
AUTOMATIC_RENEWAL_STATUS_RENEWED  = 2
RENEWED
COM_STATE_KO  = 3
KO
COM_STATE_NA  = 4
(na)
COM_STATE_NO  = 0
NO
COM_STATE_NOT_SEEN  = 5
NOT_SEEN
COM_STATE_OK  = 1
OK
COM_STATE_WARN  = 2
WARN
LQI_AVERAGE  = 1
AVERAGE
LQI_EXCELLENT  = 3
EXCELLENT
LQI_GOOD  = 2
GOOD
LQI_LIMIT  = 0
LIMIT
LQI_NA  = 4
NA
STATE_DEAD  = 1
DEAD
STATE_DELETED  = 5
DELETED
STATE_DISABLED  = 3
DISABLED
STATE_NOT_ACTIVABLE  = 7
NOT_ACTIVABLE
STATE_OFF_CONTRACT  = 2
OFF_CONTRACT
STATE_OK  = 0
OK
STATE_SUSPENDED  = 6
SUSPENDED
STATE_WARN  = 4
WARN
$actions  : array<string|int, mixed>|null
$activable  : bool|null
true if the device is activable and can take a token
$activationTime  : int|null
The device's activation time (in milliseconds since the Unix Epoch)
$automaticRenewal  : bool|null
Allow token renewal ?
$automaticRenewalStatus  : int|null
Computed automatic renewal status.
$comState  : int|null
Communication state of this device.
$contract  : MinContractInfo|null
$createdBy  : string|null
The id of device's creator user
$creationTime  : int|null
The device's provisionning time (in milliseconds since the Unix Epoch)
$deviceType  : MinDeviceType|null
$group  : MinGroup|null
$id  : string|null
The device's identifier (hexadecimal format)
$lastCom  : int|null
The last time (in milliseconds since the Unix Epoch) the device has communicated
$lastComputedLocation  : LastComputedLocation|null
$lastEditedBy  : string|null
The id of device's last editor user
$lastEditionTime  : int|null
Date of the last edition of this device (in milliseconds since the Unix Epoch)
$location  : DeviceLocation|null
$lqi  : int|null
Link Quality Indicator
$messageModulo  : int|null
The message modulo
$modemCertificate  : Certificate|null
$name  : string|null
The device's name
$pac  : string|null
The device's PAC (Porting Access Code)
$productCertificate  : Certificate|null
$prototype  : bool|null
The device is a prototype
$repeater  : bool|null
Has the device repeater function
$resources  : array<string|int, mixed>|null
$satelliteCapable  : bool|null
Can the device communicate using satellite communication
$sequenceNumber  : int|null
The last device's sequence number.
$state  : int|null
State of this device.
$token  : Token|null
$trashSequenceNumber  : int|null
The last trashed device's sequence number.
$unsubscriptionTime  : int|null
The device's unsubscription time (in milliseconds since the Unix Epoch)
from()  : static
Initializing a model from an array
getActions()  : array<string|int, string>
Getter for actions
getActivable()  : bool
Getter for activable
getActivationTime()  : int
Getter for activationTime
getAutomaticRenewal()  : bool
Getter for automaticRenewal
getAutomaticRenewalStatus()  : int
Getter for automaticRenewalStatus
getComState()  : int
Getter for comState
getContract()  : MinContractInfo
Getter for contract
getCreatedBy()  : string
Getter for createdBy
getCreationTime()  : int
Getter for creationTime
getDeviceType()  : MinDeviceType
Getter for deviceType
getGroup()  : MinGroup
Getter for group
getId()  : string
Getter for id
getLastCom()  : int
Getter for lastCom
getLastComputedLocation()  : LastComputedLocation
Getter for lastComputedLocation
getLastEditedBy()  : string
Getter for lastEditedBy
getLastEditionTime()  : int
Getter for lastEditionTime
getLocation()  : DeviceLocation
Getter for location
getLqi()  : int
Getter for lqi
getMessageModulo()  : int
Getter for messageModulo
getModemCertificate()  : Certificate
Getter for modemCertificate
getName()  : string
Getter for name
getPac()  : string
Getter for pac
getProductCertificate()  : Certificate
Getter for productCertificate
getPrototype()  : bool
Getter for prototype
getRepeater()  : bool
Getter for repeater
getResources()  : array<string|int, string>
Getter for resources
getSatelliteCapable()  : bool
Getter for satelliteCapable
getSequenceNumber()  : int
Getter for sequenceNumber
getState()  : int
Getter for state
getToken()  : Token
Getter for token
getTrashSequenceNumber()  : int
Getter for trashSequenceNumber
getUnsubscriptionTime()  : int
Getter for unsubscriptionTime
jsonSerialize()  : array<string|int, mixed>
setActions()  : static
Setter for actions
setActivable()  : static
Setter for activable
setActivationTime()  : static
Setter for activationTime
setAutomaticRenewal()  : static
Setter for automaticRenewal
setAutomaticRenewalStatus()  : static
Setter for automaticRenewalStatus
setComState()  : static
Setter for comState
setContract()  : static
Setter for contract
setCreatedBy()  : static
Setter for createdBy
setCreationTime()  : static
Setter for creationTime
setDeviceType()  : static
Setter for deviceType
setGroup()  : static
Setter for group
setId()  : static
Setter for id
setLastCom()  : static
Setter for lastCom
setLastComputedLocation()  : static
Setter for lastComputedLocation
setLastEditedBy()  : static
Setter for lastEditedBy
setLastEditionTime()  : static
Setter for lastEditionTime
setLocation()  : static
Setter for location
setLqi()  : static
Setter for lqi
setMessageModulo()  : static
Setter for messageModulo
setModemCertificate()  : static
Setter for modemCertificate
setName()  : static
Setter for name
setPac()  : static
Setter for pac
setProductCertificate()  : static
Setter for productCertificate
setPrototype()  : static
Setter for prototype
setRepeater()  : static
Setter for repeater
setResources()  : static
Setter for resources
setSatelliteCapable()  : static
Setter for satelliteCapable
setSequenceNumber()  : static
Setter for sequenceNumber
setState()  : static
Setter for state
setToken()  : static
Setter for token
setTrashSequenceNumber()  : static
Setter for trashSequenceNumber
setUnsubscriptionTime()  : static
Setter for unsubscriptionTime

Constants

AUTOMATIC_RENEWAL_STATUS_ALLOWED

ALLOWED

public mixed AUTOMATIC_RENEWAL_STATUS_ALLOWED = 0

AUTOMATIC_RENEWAL_STATUS_ENDED

ENDED

public mixed AUTOMATIC_RENEWAL_STATUS_ENDED = 3

AUTOMATIC_RENEWAL_STATUS_NOT_ALLOWED

NOT_ALLOWED

public mixed AUTOMATIC_RENEWAL_STATUS_NOT_ALLOWED = 1

AUTOMATIC_RENEWAL_STATUS_RENEWED

RENEWED

public mixed AUTOMATIC_RENEWAL_STATUS_RENEWED = 2

COM_STATE_KO

KO

public mixed COM_STATE_KO = 3

COM_STATE_NA

(na)

public mixed COM_STATE_NA = 4

COM_STATE_NO

NO

public mixed COM_STATE_NO = 0

COM_STATE_NOT_SEEN

NOT_SEEN

public mixed COM_STATE_NOT_SEEN = 5

COM_STATE_OK

OK

public mixed COM_STATE_OK = 1

COM_STATE_WARN

WARN

public mixed COM_STATE_WARN = 2

LQI_AVERAGE

AVERAGE

public mixed LQI_AVERAGE = 1

LQI_EXCELLENT

EXCELLENT

public mixed LQI_EXCELLENT = 3

LQI_GOOD

GOOD

public mixed LQI_GOOD = 2

LQI_LIMIT

LIMIT

public mixed LQI_LIMIT = 0

LQI_NA

NA

public mixed LQI_NA = 4

STATE_DEAD

DEAD

public mixed STATE_DEAD = 1

STATE_DELETED

DELETED

public mixed STATE_DELETED = 5

STATE_DISABLED

DISABLED

public mixed STATE_DISABLED = 3

STATE_NOT_ACTIVABLE

NOT_ACTIVABLE

public mixed STATE_NOT_ACTIVABLE = 7

STATE_OFF_CONTRACT

OFF_CONTRACT

public mixed STATE_OFF_CONTRACT = 2

STATE_OK

OK

public mixed STATE_OK = 0

STATE_SUSPENDED

SUSPENDED

public mixed STATE_SUSPENDED = 6

STATE_WARN

WARN

public mixed STATE_WARN = 4

Properties

$actions

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

$activable

true if the device is activable and can take a token

protected bool|null $activable = null

$activationTime

The device's activation time (in milliseconds since the Unix Epoch)

protected int|null $activationTime = null

$automaticRenewal

Allow token renewal ?

protected bool|null $automaticRenewal = null

$createdBy

The id of device's creator user

protected string|null $createdBy = null

$creationTime

The device's provisionning time (in milliseconds since the Unix Epoch)

protected int|null $creationTime = null

$id

The device's identifier (hexadecimal format)

protected string|null $id = null

$lastCom

The last time (in milliseconds since the Unix Epoch) the device has communicated

protected int|null $lastCom = null

$lastEditedBy

The id of device's last editor user

protected string|null $lastEditedBy = null

$lastEditionTime

Date of the last edition of this device (in milliseconds since the Unix Epoch)

protected int|null $lastEditionTime = null

$messageModulo

The message modulo

protected int|null $messageModulo = null

$name

The device's name

protected string|null $name = null

$pac

The device's PAC (Porting Access Code)

protected string|null $pac = null

$prototype

The device is a prototype

protected bool|null $prototype = null

$repeater

Has the device repeater function

protected bool|null $repeater = null

$resources

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

$satelliteCapable

Can the device communicate using satellite communication

protected bool|null $satelliteCapable = null

$sequenceNumber

The last device's sequence number.

protected int|null $sequenceNumber = null

Absent if the device has never communicated or if the SIGFOX message protocol is V0

$trashSequenceNumber

The last trashed device's sequence number.

protected int|null $trashSequenceNumber = null

Absent if there is no message trashed or if the SIGFOX message protocol is V0

$unsubscriptionTime

The device's unsubscription time (in milliseconds since the Unix Epoch)

protected int|null $unsubscriptionTime = 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 —

getActions()

Getter for actions

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

getActivable()

Getter for activable

public getActivable() : bool
Return values
bool —

true if the device is activable and can take a token

getActivationTime()

Getter for activationTime

public getActivationTime() : int
Return values
int —

The device's activation time (in milliseconds since the Unix Epoch)

getAutomaticRenewal()

Getter for automaticRenewal

public getAutomaticRenewal() : bool
Return values
bool —

Allow token renewal ?

getCreatedBy()

Getter for createdBy

public getCreatedBy() : string
Return values
string —

The id of device's creator user

getCreationTime()

Getter for creationTime

public getCreationTime() : int
Return values
int —

The device's provisionning time (in milliseconds since the Unix Epoch)

getId()

Getter for id

public getId() : string
Return values
string —

The device's identifier (hexadecimal format)

getLastCom()

Getter for lastCom

public getLastCom() : int
Return values
int —

The last time (in milliseconds since the Unix Epoch) the device has communicated

getLastEditedBy()

Getter for lastEditedBy

public getLastEditedBy() : string
Return values
string —

The id of device's last editor user

getLastEditionTime()

Getter for lastEditionTime

public getLastEditionTime() : int
Return values
int —

Date of the last edition of this device (in milliseconds since the Unix Epoch)

getMessageModulo()

Getter for messageModulo

public getMessageModulo() : int
Return values
int —

The message modulo

getName()

Getter for name

public getName() : string
Return values
string —

The device's name

getPac()

Getter for pac

public getPac() : string
Return values
string —

The device's PAC (Porting Access Code)

getPrototype()

Getter for prototype

public getPrototype() : bool
Return values
bool —

The device is a prototype

getRepeater()

Getter for repeater

public getRepeater() : bool
Return values
bool —

Has the device repeater function

getResources()

Getter for resources

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

getSatelliteCapable()

Getter for satelliteCapable

public getSatelliteCapable() : bool
Return values
bool —

Can the device communicate using satellite communication

getSequenceNumber()

Getter for sequenceNumber

public getSequenceNumber() : int
Return values
int —

The last device's sequence number. Absent if the device has never communicated or if the SIGFOX message protocol is V0

getTrashSequenceNumber()

Getter for trashSequenceNumber

public getTrashSequenceNumber() : int
Return values
int —

The last trashed device's sequence number. Absent if there is no message trashed or if the SIGFOX message protocol is V0

getUnsubscriptionTime()

Getter for unsubscriptionTime

public getUnsubscriptionTime() : int
Return values
int —

The device's unsubscription time (in milliseconds since the Unix Epoch)

jsonSerialize()

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

setActions()

Setter for actions

public setActions(array<string|int, string> $actions) : static
Parameters
$actions : array<string|int, string>
Return values
static —

To use in method chains

setActivable()

Setter for activable

public setActivable(bool $activable) : static
Parameters
$activable : bool

true if the device is activable and can take a token

Return values
static —

To use in method chains

setActivationTime()

Setter for activationTime

public setActivationTime(int $activationTime) : static
Parameters
$activationTime : int

The device's activation time (in milliseconds since the Unix Epoch)

Return values
static —

To use in method chains

setAutomaticRenewal()

Setter for automaticRenewal

public setAutomaticRenewal(bool $automaticRenewal) : static
Parameters
$automaticRenewal : bool

Allow token renewal ?

Return values
static —

To use in method chains

setCreatedBy()

Setter for createdBy

public setCreatedBy(string $createdBy) : static
Parameters
$createdBy : string

The id of device's creator user

Return values
static —

To use in method chains

setCreationTime()

Setter for creationTime

public setCreationTime(int $creationTime) : static
Parameters
$creationTime : int

The device's provisionning time (in milliseconds since the Unix Epoch)

Return values
static —

To use in method chains

setDeviceType()

Setter for deviceType

public setDeviceType(MinDeviceType $deviceType) : static
Parameters
$deviceType : MinDeviceType
Return values
static —

To use in method chains

setGroup()

Setter for group

public setGroup(MinGroup $group) : static
Parameters
$group : MinGroup
Return values
static —

To use in method chains

setId()

Setter for id

public setId(string $id) : static
Parameters
$id : string

The device's identifier (hexadecimal format)

Return values
static —

To use in method chains

setLastCom()

Setter for lastCom

public setLastCom(int $lastCom) : static
Parameters
$lastCom : int

The last time (in milliseconds since the Unix Epoch) the device has communicated

Return values
static —

To use in method chains

setLastComputedLocation()

Setter for lastComputedLocation

public setLastComputedLocation(LastComputedLocation $lastComputedLocation) : static
Parameters
$lastComputedLocation : LastComputedLocation
Return values
static —

To use in method chains

setLastEditedBy()

Setter for lastEditedBy

public setLastEditedBy(string $lastEditedBy) : static
Parameters
$lastEditedBy : string

The id of device's last editor user

Return values
static —

To use in method chains

setLastEditionTime()

Setter for lastEditionTime

public setLastEditionTime(int $lastEditionTime) : static
Parameters
$lastEditionTime : int

Date of the last edition of this device (in milliseconds since the Unix Epoch)

Return values
static —

To use in method chains

setLocation()

Setter for location

public setLocation(DeviceLocation $location) : static
Parameters
$location : DeviceLocation
Return values
static —

To use in method chains

setMessageModulo()

Setter for messageModulo

public setMessageModulo(int $messageModulo) : static
Parameters
$messageModulo : int

The message modulo

Return values
static —

To use in method chains

setModemCertificate()

Setter for modemCertificate

public setModemCertificate(Certificate $modemCertificate) : static
Parameters
$modemCertificate : Certificate
Return values
static —

To use in method chains

setName()

Setter for name

public setName(string $name) : static
Parameters
$name : string

The device's name

Return values
static —

To use in method chains

setPac()

Setter for pac

public setPac(string $pac) : static
Parameters
$pac : string

The device's PAC (Porting Access Code)

Return values
static —

To use in method chains

setProductCertificate()

Setter for productCertificate

public setProductCertificate(Certificate $productCertificate) : static
Parameters
$productCertificate : Certificate
Return values
static —

To use in method chains

setPrototype()

Setter for prototype

public setPrototype(bool $prototype) : static
Parameters
$prototype : bool

The device is a prototype

Return values
static —

To use in method chains

setRepeater()

Setter for repeater

public setRepeater(bool $repeater) : static
Parameters
$repeater : bool

Has the device repeater function

Return values
static —

To use in method chains

setResources()

Setter for resources

public setResources(array<string|int, string> $resources) : static
Parameters
$resources : array<string|int, string>
Return values
static —

To use in method chains

setSatelliteCapable()

Setter for satelliteCapable

public setSatelliteCapable(bool $satelliteCapable) : static
Parameters
$satelliteCapable : bool

Can the device communicate using satellite communication

Return values
static —

To use in method chains

setSequenceNumber()

Setter for sequenceNumber

public setSequenceNumber(int $sequenceNumber) : static
Parameters
$sequenceNumber : int

The last device's sequence number. Absent if the device has never communicated or if the SIGFOX message protocol is V0

Return values
static —

To use in method chains

setToken()

Setter for token

public setToken(Token $token) : static
Parameters
$token : Token
Return values
static —

To use in method chains

setTrashSequenceNumber()

Setter for trashSequenceNumber

public setTrashSequenceNumber(int $trashSequenceNumber) : static
Parameters
$trashSequenceNumber : int

The last trashed device's sequence number. Absent if there is no message trashed or if the SIGFOX message protocol is V0

Return values
static —

To use in method chains

setUnsubscriptionTime()

Setter for unsubscriptionTime

public setUnsubscriptionTime(int $unsubscriptionTime) : static
Parameters
$unsubscriptionTime : int

The device's unsubscription time (in milliseconds since the Unix Epoch)

Return values
static —

To use in method chains

Search results