Daemon API

JSON messages for communication via MQ/WS/MQTT channels. Messages has been tested with OS v4.02D and DPA v3.02 at TR-7xD and higher. Check with DPA release pages the relevance of particular DPA cmds. Some DPA cmds were updated/added/removed in further versions of DPA.

IQRF Gateway Daemon API categories:

IQRF GWD API categories

IQRF Generic

Generic messages are able to handle any DPA packet.

Raw

• Raw request v1-0-0 and example
• Raw response v1-0-0 and example

RawHdp

• RawHdp request v1-0-0 and example
• RawHdp response v1-0-0 and and example

IQRF Standard

Standard messages has been design according to IQRF Standard and DPA protocol.

Binaryoutput

• Enumerate BO request v1-0-0 and example
• Enumerate BO response v1-0-0 and example
• SetOutput request v1-0-0 and example
• SetOutput response v1-0-0 and example

Dali

• SendCommands request v1-0-0 and example
• SendCommands response v1-0-0 and example
• SendCommandsAsync request v1-0-0 and example
• SendCommandsAsync response v1-0-0 and example
• Dali Frc request v1-0-0 and example
• Dali Frc response v1-0-0 and example

Light

• Enumerate L request v1-0-0 and example
• Enumerate L response v1-0-0 and example
• SetPower request v1-0-0 and example
• SetPower response v1-0-0 and example
• IncrementPower request v1-0-0 and example
• IncrementPower response v1-0-0 and example
• DecrementPower request v1-0-0 and example
• DecrementPower response v1-0-0 and example

Sensor

• Enumerate S request v1-0-0 and example
• Enumerate S response v1-0-0 and example
• ReadSensorsWithTypes request v1-0-0 and example
• ReadSensorsWithTypes response v1-0-0 and example
• Frc request v1-0-0 and example
• Frc response v1-0-0 and example

Embed Explore

• Enumerate request v1-0-0 and example
• Enumerate response v1-0-0 and example
• PeripheralInformation request v1-0-0 and example
• PeripheralInformation response v1-0-0 and example
• MorePeripheralsInformation request v1-0-0 and example
• MorePeripheralsInformation response v1-0-0 and example

Embed Coordinator

• AddrInfo request v1-0-0 and example
• AddrInfo response v1-0-0 and example
• DiscoveredDevices request v1-0-0 and example
• DiscoveredDevices response v1-0-0 and example
• BondedDevices request v1-0-0 and example
• BondedDevices response v1-0-0 and example
• ClearAllBonds request v1-0-0 and example
• ClearAllBonds response v1-0-0 and example
• BondNode request v1-0-0 and example
• BondNode response v1-0-0 and example
• RemoveBond C request v1-0-0 and example
• RemoveBond C response v1-0-0 and example
• Discovery request v1-0-0 and example
• Discovery response v1-0-0 and example
• SetDpaParams request v1-0-0 and example
• SetDpaParams response v1-0-0 and example
• SetHops request v1-0-0 and example
• SetHops response v1-0-0 and example
• DiscoveryData request v1-0-0 and example
• DiscoveryData response v1-0-0 and example
• Backup C request v1-0-0 and example
• Backup C response v1-0-0 and example
• Restore C request v1-0-0 and example
• Restore C response v1-0-0 and example
• AuthorizeBond request v1-0-0 and example
• AuthorizeBond response v1-0-0 and example
• ReadRemotelyBondedMid C request v1-0-0 and example
• ReadRemotelyBondedMid C response v1-0-0 and example
• ClearRemotelyBondedMid C request v1-0-0 and example
• ClearRemotelyBondedMid C response v1-0-0 and example
• EnableRemoteBonding C request v1-0-0 and example
• EnableRemoteBonding C response v1-0-0 and example
• SmartConnect C request v1-0-0 and example
• SmartConnect C response v1-0-0 and example
• SetMID request v1-0-0 and example
• SetMID response v1-0-0 and example

Embed Node

• Read N request v1-0-0 and example
• Read N response v1-0-0 and example
• RemoveBond N request v1-0-0 and example
• RemoveBond N response v1-0-0 and example
• Backup N request v1-0-0 and example
• Backup N response v1-0-0 and example
• Restore N request v1-0-0 and example
• Restore N response v1-0-0 and example
• ReadRemotelyBondedMid N request v1-0-0 and example
• ReadRemotelyBondedMid N response v1-0-0 and example
• ClearRemotelyBondedMid N request v1-0-0 and example
• ClearRemotelyBondedMid N response v1-0-0 and example
• EnableRemoteBonding N request v1-0-0 and example
• EnableRemoteBonding N response v1-0-0 and example
• ValidateBonds request v1-0-0 and example
• ValidateBonds response v1-0-0 and example

Embed OS

• Read OS request v1-0-0 and example
• Read OS response v1-0-0 and example
• Batch request v1-0-0 and example
• Batch response v1-0-0 and example
• SelectiveBatch request v1-0-0 and example
• SelectiveBatch response v1-0-0 and example
• Reset request v1-0-0 and example
• Reset response v1-0-0 and example
• Restart request v1-0-0 and example
• Restart response v1-0-0 and example
• Rfpgm request v1-0-0 and example
• Rfpgm response v1-0-0 and example
• SetSecurity request v1-0-0 and example
• SetSecurity response v1-0-0 and example
• Sleep request v1-0-0 and example
• Sleep response v1-0-0 and example
• LoadCode request v1-0-0 and example
• LoadCode response v1-0-0 and example
• ReadCfg request v1-0-0 and example
• ReadCfg response v1-0-0 and example
• WriteCfg request v1-0-0 and example
• WriteCfg response v1-0-0 and example
• WriteCfgByte request v1-0-0 and example
• WriteCfgByte response v1-0-0 and example
• TestRfSignal request v1-0-0 and example
• TestRfSignal response v1-0-0 and example
• FactorySettings request v1-0-0 and example
• FactorySettings response v1-0-0 and example
• Indicate request v1-0-0 and example
• Indicate response v1-0-0 and example

Embed EEPROM

• Read EE request v1-0-0 and example
• Read EE response v1-0-0 and example
• Write EE request v1-0-0 and example
• Write EE response v1-0-0 and example

Embed EEEPROM

• Read EEE request v1-0-0 and example
• Read EEE response v1-0-0 and example
• Write EEE request v1-0-0 and example
• Write EEE response v1-0-0 and example

Embed RAM

• Read RAM request v1-0-0 and example
• Read RAM response v1-0-0 and example
• Write RAM request v1-0-0 and example
• Write RAM response v1-0-0 and example

Embed SPI

• WriteRead SPI request v1-0-0 and example
• WriteRead SPI response v1-0-0 and example

Embed LEDR

• Set LEDR request v1-0-0 and example
• Set LEDR response v1-0-0 and example
• Get LEDR request v1-0-0 and example
• Get LEDR response v1-0-0 and example
• Pulse LEDR request v1-0-0 and example
• Pulse LEDR response v1-0-0 and example
• Flashing LEDR request v1-0-0 and example
• Flashing LEDR response v1-0-0 and example

Embed LEDG

• Set LEDG request v1-0-0 and example
• Set LEDG response v1-0-0 and example
• Get LEDG request v1-0-0 and example
• Get LEDG response v1-0-0 and example
• Pulse LEDG request v1-0-0 and example
• Pulse LEDG response v1-0-0 and example
• Flashing LEDG request v1-0-0 and example
• Flashing LEDG response v1-0-0 and example

Embed IO

• Direction IO request v1-0-0 and example
• Direction IO response v1-0-0 and example
• Set IO request v1-0-0 and example
• Set IO response v1-0-0 and example
• Get IO request v1-0-0 and example
• Get IO response v1-0-0 and example

Embed Thermometer

• Read T request v1-0-0 and example
• Read T response v1-0-0 and example

Embed Uart

• Open UART request v1-0-0 and example
• Open UART response v1-0-0 and example
• Close UART request v1-0-0 and example
• Close UART response v1-0-0 and example
• WriteRead UART request v1-0-0 and example
• WriteRead UART response v1-0-0 and example
• ClearWriteRead UART request v1-0-0 and example
• ClearWriteRead UART response v1-0-0 and example

Embed Frc

• Send request v1-0-0 and example
• Send response v1-0-0 and example
• ExtraResult request v1-0-0 and example
• ExtraResult response v1-0-0 and example
• SendSelective request v1-0-0 and example
• SendSelective response v1-0-0 and example
• SetParams request v1-0-0 and example
• SetParams response v1-0-0 and example

IQMESH Network

Services that ease the task of working with IQMESH network. They are composed of more then single DPA transaction (req-cnf-rsp) in most of the cases. They are also integrating information from IQRF Repository. They are inspired by the services available in IQRF IDE - IQMESH Network Manager.

IQRF Bonding

• BondNodeLocal request v1-0-0 and example
• BondNodeLocal response v1-0-0 and example
• SmartConnect request v1-0-0 and example
• SmartConnect response v1-0-0 and example
• RemoveBond request v1-0-0 and example
• RemoveBond response v1-0-0 and example
• RemoveBondOnlyInC request v1-0-0 and example
• RemoveBondOnlyInC response v1-0-0 and example
• AutoNetwork request v1-0-0 and example
• AutoNetwork response v1-0-0 and example

IQRF Enumeration

• EnumerateDevice request v1-0-0 and example
• EnumerateDevice response v1-0-0 and example

IQRF Configuration

• ReadTrConf request v1-0-0 and example
• ReadTrConf response v1-0-0 and example
• WriteTrConf request v1-0-0 and example
• WriteTrConf response v1-0-0 and example

IQRF Backup/Restore

• Backup request v1-0-0 and example
• Backup response v1-0-0 and example
• Restore request v1-0-0 and example
• Restore response v1-0-0 and example

IQRF OTA

• OtaUpload request v1-0-0 and example
• OtaUpload response v1-0-0 and example

Daemon Management

• Exit request v1-0-0 and example
• Exit response v1-0-0 and example
• Mode request v1-0-0 and example
• Mode response v1-0-0 and example
• Version request v1-0-0 and example
• Version response v1-0-0 and example

Daemon Configuration

• Component request v1-0-0 and example
• Component response v1-0-0 and example

Daemon Scheduler

• AddTask request v1-0-0 and example
• AddTask response v1-0-0 and example
• GetTask request v1-0-0 and example
• GetTask response v1-0-0 and example
• List request v1-0-0 and example
• List response v1-0-0 and example
• RemoveAll request v1-0-0 and example
• RemoveAll response v1-0-0 and example
• RemoveTask request v1-0-0 and example
• RemoveTask response v1-0-0 and example

Daemon Metadata

• SetMetaData request v1-0-0 and example
• SetMetaData response v1-0-0 and example
• GetMetaData request v1-0-0 and example
• GetMetaData response v1-0-0 and example
• SetMidMetaId request v1-0-0 and example
• SetMidMetaId response v1-0-0 and example
• GetMidMetaData request v1-0-0 and example
• GetMidMetaData response v1-0-0 and example
• GetNadrMetaData request v1-0-0 and example
• GetNadrMetaData response v1-0-0 and example
• ExportMetaDataAll request v1-0-0 and example
• ExportMetaDataAll response v1-0-0 and example
• VerifyMetaDataAll request v1-0-0 and example
• VerifyMetaDataAll response v1-0-0 and example
• ImportMetaDataAll request v1-0-0 and example
• ImportMetaDataAll response v1-0-0 and example
• ImportNadrMidMap request v1-0-0 and example
• ImportNadrMidMap response v1-0-0 and example
• ExportNadrMidMap request v1-0-0 and example
• ExportNadrMidMap response v1-0-0 and example

Daemon Notification

Daemon state notifications related to interfaces, modes via websocket channel on port 1438.

• Monitor message v1-0-0 and example