\Iqrf\Repository\Entities\Metadata MetadataProfile

MetadataProfile entity

Summary

Methods
Properties
Constants
__construct
fromApiResponseV0
fromApiResponseV1
jsonSerialize
hwpidVersions
routing
beaming
repeater
frcAggregation
iqarosCompatible
iqrfSensor
iqrfBinaryOutput
powerSupply
sensorData
iqrfLight
minMaxDiag
actionRecord
persistentQuantities
nfcc
mfgc
calibration
No public constants found
No protected methods found
No protected properties found
No protected constants found
No private methods found
No private properties found
No private constants found

Properties

$hwpidVersions

$hwpidVersions : \Iqrf\Repository\Entities\Metadata\HwpidVersions

Type

HwpidVersions

$routing

$routing : bool

Type

bool

$beaming

$beaming : bool

Type

bool

$repeater

$repeater : bool

Type

bool

$frcAggregation

$frcAggregation : bool

Type

bool

$iqarosCompatible

$iqarosCompatible : bool

Type

bool

$iqrfSensor

$iqrfSensor : array

Type

array<string|int, mixed>

$iqrfBinaryOutput

$iqrfBinaryOutput : int

Type

int

$powerSupply

$powerSupply : \Iqrf\Repository\Entities\Metadata\PowerSupply

Type

PowerSupply

$sensorData

$sensorData : array

Type

array<string|int, mixed>

$iqrfLight

$iqrfLight : ?\Iqrf\Repository\Entities\Metadata\IqrfLight

Type

IqrfLight|null

$minMaxDiag

$minMaxDiag : ?\Iqrf\Repository\Entities\Metadata\MinMaxDiag

Type

MinMaxDiag|null

$actionRecord

$actionRecord : ?\Iqrf\Repository\Entities\Metadata\ActionRecord

Type

ActionRecord|null

$persistentQuantities

$persistentQuantities : array

Type

array<string|int, mixed>

$nfcc

$nfcc : ?\Iqrf\Repository\Entities\Metadata\Nfc

Type

Nfc|null

$mfgc

$mfgc : ?\Iqrf\Repository\Entities\Metadata\Mfgc

Type

Mfgc|null

$calibration

$calibration : ?\Iqrf\Repository\Entities\Metadata\Calibration

Type

Calibration|null

Methods

__construct()

__construct(\Iqrf\Repository\Entities\Metadata\HwpidVersions  $hwpidVersions, bool  $routing, bool  $beaming, bool  $repeater, bool  $frcAggregation, bool  $iqarosCompatible, int[]  $iqrfSensor, int  $iqrfBinaryOutput, \Iqrf\Repository\Entities\Metadata\PowerSupply  $powerSupply, \Iqrf\Repository\Entities\Metadata\SensorData[]  $sensorData = [], \Iqrf\Repository\Entities\Metadata\IqrfLight|null  $iqrfLight = null, \Iqrf\Repository\Entities\Metadata\MinMaxDiag|null  $minMaxDiag = null, \Iqrf\Repository\Entities\Metadata\ActionRecord|null  $actionRecord = null, \Iqrf\Repository\Entities\Metadata\PersistentQuantity[]  $persistentQuantities = [], \Iqrf\Repository\Entities\Metadata\Nfc|null  $nfcc = null, \Iqrf\Repository\Entities\Metadata\Mfgc|null  $mfgc = null, \Iqrf\Repository\Entities\Metadata\Calibration|null  $calibration = null) : mixed

Constructs MetadataProfile metadata object.

Parameters

\Iqrf\Repository\Entities\Metadata\HwpidVersions $hwpidVersions

Minimum HWPID version the profile applies to.

bool $routing

Device is capable of routing packets in network.

bool $beaming

Device beams data in intervals and sleeps otherwise.

bool $repeater

Device is a repeater.

bool $frcAggregation

Device is capable of aggregating FRC data from other devices.

bool $iqarosCompatible

Device is compatible with the IQAROS system.

int[] $iqrfSensor

Sensor standard capabilities implemented by the device.

int $iqrfBinaryOutput

Number of binary outputs this device implements.

\Iqrf\Repository\Entities\Metadata\PowerSupply $powerSupply

Definition of power supply options of the device and spec.

\Iqrf\Repository\Entities\Metadata\SensorData[] $sensorData

Extension of iqrfSensor, carrying additional properties. Each object corresponds positionally to values in iqrfSensor.

\Iqrf\Repository\Entities\Metadata\IqrfLight|null $iqrfLight

Light standard capabilities implemented by the device.

\Iqrf\Repository\Entities\Metadata\MinMaxDiag|null $minMaxDiag

Device can store historical minimum and maximum of quantity measurements and reset them.

\Iqrf\Repository\Entities\Metadata\ActionRecord|null $actionRecord

Definition of available user actions.

\Iqrf\Repository\Entities\Metadata\PersistentQuantity[] $persistentQuantities

Values of IQRF standard quantities persisted in memory.

\Iqrf\Repository\Entities\Metadata\Nfc|null $nfcc

Device implements NFC communication channel.

\Iqrf\Repository\Entities\Metadata\Mfgc|null $mfgc

Device implements test communication channel for production.

\Iqrf\Repository\Entities\Metadata\Calibration|null $calibration

Device contains calibration data.

Returns

mixed —

fromApiResponseV0()

fromApiResponseV0(array{hwpidVersions: array{min: int, max: int}, routing: bool, beaming: bool, repeater: bool, frcAggregation: bool, iqarosCompatible: bool, iqrfSensor: int[], iqrfBinaryOutput: int, powerSupply: array{mains: bool, accumulator: array{present: bool, type: string|null, lowLevel: float|null}, battery: array{present: bool, type: string|null, changeThreshold: float|null}, minVoltage: float}}  $response) : \Iqrf\Repository\Entities\Metadata\MetadataProfile

Parses the provided response data into MetadataProfile object

Parameters

array{hwpidVersions: array{min: int, max: int}, routing: bool, beaming: bool, repeater: bool, frcAggregation: bool, iqarosCompatible: bool, iqrfSensor: int[], iqrfBinaryOutput: int, powerSupply: array{mains: bool, accumulator: array{present: bool, type: string|null, lowLevel: float|null}, battery: array{present: bool, type: string|null, changeThreshold: float|null}, minVoltage: float}} $response

API response body

Throws

\InvalidArgumentException

Thrown if required properties are missing

Returns

\Iqrf\Repository\Entities\Metadata\MetadataProfile —

The parsed MetadataProfile object

fromApiResponseV1()

fromApiResponseV1(array{hwpidVersions: array{min: int, max: int}, routing: bool, beaming: bool, repeater: bool, frcAggregation: bool, iqarosCompatible: bool, iqrfSensor: int[], iqrfBinaryOutput: int, powerSupply: array{mains: bool, accumulator: array{present: bool, type: string|null, lowLevel: float|null}, battery: array{present: bool, type: string|null, changeThreshold: float|null, conditioning?: bool}, minVoltage: float, external?: array{type?: string, nominalVoltage?: float, minVoltage?: float, maxVoltage?: float}}, iqrfSensorData?: array[], iqrfLight?: array{type?: string, socketType?: string}, minMaxDiag?: array{version?: int}, actionRecord?: array{memory?: array{type: int, addr: int, size: int}, commands?: array{value: int, text: string}[]}, persistentQuantities?: array{quantity?: int, value?: int, description?: string, memory?: array{type?: int, addr?: int}}[], nfcc?: array{version?: int, notSecured?: array{dpaMenu?: int[], dpaCommands?: array{pnum: int, pcmd: int}[]}, secured?: array{dpaCommands?: array{pnum: int, pcmd: int}[]}}, mfgc?: array{version?: int}, calibration?: array{version?: int}}  $response) : \Iqrf\Repository\Entities\Metadata\MetadataProfile

Deserializes MetadataProfile data from a JSON array.

Parameters

array{hwpidVersions: array{min: int, max: int}, routing: bool, beaming: bool, repeater: bool, frcAggregation: bool, iqarosCompatible: bool, iqrfSensor: int[], iqrfBinaryOutput: int, powerSupply: array{mains: bool, accumulator: array{present: bool, type: string|null, lowLevel: float|null}, battery: array{present: bool, type: string|null, changeThreshold: float|null, conditioning?: bool}, minVoltage: float, external?: array{type?: string, nominalVoltage?: float, minVoltage?: float, maxVoltage?: float}}, iqrfSensorData?: array[], iqrfLight?: array{type?: string, socketType?: string}, minMaxDiag?: array{version?: int}, actionRecord?: array{memory?: array{type: int, addr: int, size: int}, commands?: array{value: int, text: string}[]}, persistentQuantities?: array{quantity?: int, value?: int, description?: string, memory?: array{type?: int, addr?: int}}[], nfcc?: array{version?: int, notSecured?: array{dpaMenu?: int[], dpaCommands?: array{pnum: int, pcmd: int}[]}, secured?: array{dpaCommands?: array{pnum: int, pcmd: int}[]}}, mfgc?: array{version?: int}, calibration?: array{version?: int}} $response

MetadataProfile data for deserialization from JSON

Throws

\InvalidArgumentException

Thrown if required properties are missing

Returns

\Iqrf\Repository\Entities\Metadata\MetadataProfile —

The parsed MetadataProfile object

jsonSerialize()

jsonSerialize() : array{hwpidVersions: array{min: int, max: int}, routing: bool, beaming: bool, repeater: bool, frcAggregation: bool, iqarosCompatible: bool, iqrfSensor: int[], iqrfBinaryOutput: int, powerSupply: array{mains: bool, accumulator: array{present: bool, type: string|null, lowLevel: float|null}, battery: array{present: bool, type: string|null, changeThreshold: float|null, conditioning?: bool}, minVoltage: float, external?: array{type?: string, nominalVoltage?: float, minVoltage?: float, maxVoltage?: float}}, iqrfSensorData?: array<string,mixed>[], iqrfLight?: array{type?: string, socketType?: string}, minMaxDiag?: array{version?: int}, actionRecord?: array{memory?: array{type?: int, addr?: int, size?: int}, commands?: array{value?: int, text?: string}[]}, persistentQuantities?: array{quantity?: int, value?: int, description?: string, memory?: array{type?: int, addr?: int}}[], nfcc?: array{version?: int, notSecured?: array{memory?: array{type?: int, addr?: int, size?: int}, commands?: array{pnum: int, pcmd: int}[]}, secured?: array{commands?: array{pnum: int, pcmd: int}[]}}, mfgc?: array{version?: int}, calibration?: array{version?: int}}

Serializes the MetadataProfile entity into JSON

Returns

array{hwpidVersions: array{min: int, max: int}, routing: bool, beaming: bool, repeater: bool, frcAggregation: bool, iqarosCompatible: bool, iqrfSensor: int[], iqrfBinaryOutput: int, powerSupply: array{mains: bool, accumulator: array{present: bool, type: string|null, lowLevel: float|null}, battery: array{present: bool, type: string|null, changeThreshold: float|null, conditioning?: bool}, minVoltage: float, external?: array{type?: string, nominalVoltage?: float, minVoltage?: float, maxVoltage?: float}}, iqrfSensorData?: array[], iqrfLight?: array{type?: string, socketType?: string}, minMaxDiag?: array{version?: int}, actionRecord?: array{memory?: array{type?: int, addr?: int, size?: int}, commands?: array{value?: int, text?: string}[]}, persistentQuantities?: array{quantity?: int, value?: int, description?: string, memory?: array{type?: int, addr?: int}}[], nfcc?: array{version?: int, notSecured?: array{memory?: array{type?: int, addr?: int, size?: int}, commands?: array{pnum: int, pcmd: int}[]}, secured?: array{commands?: array{pnum: int, pcmd: int}[]}}, mfgc?: array{version?: int}, calibration?: array{version?: int}} —

JSON-serialized MetadataProfile data