Daemon API v2.3.x

IQRF Generic

Generic messages are able to handle any DPA packet.

Raw iqrfRaw

Schema	Example

RawHdp iqrfRawHdp

Schema	Example

IQRF Standard

Standard messages have been designed according to IQRF Standard and DPA protocol.

Status codes

Status codes between 0 and 255 are based on the DPA framework, status codes from 32 to 63 are reserved for implementations of user peripherals. Asynchronous responses are marked by bit 7 set to 1. Negative status codes represent issues occurring during communication with the IQRF interfaces. For more details about each of the messages, click the DPA doc badge to view the corresponding DPA peripheral command page.

Code	Message	Description
0	ok	Request has been handled successfully.
1	ERROR_FAIL	General failure code representing further unspecified issues.
2	ERROR_PCMD	The peripheral does not support the specified command.
3	ERROR_PNUM	The specified peripheral is not supported or the peripheral does not support the specified command.
4	ERROR_ADDR	Incorrect address parameter. The address may be out of range.
5	ERROR_DATA_LEN	The number of request data bytes is not correct for specified peripheral command.
6	ERROR_DATA	The request message data is not valid for the specified peripheral command. This usually translates to value being out of range of accepted values.
7	ERROR_HWPID	The specified HWPID does not correspond to an HWPID of the device.
8	ERROR_NADR	The specified node address does not corresponding to a bonded node.
9	ERROR_IFACE_CUSTOM_HANDLER	Data from interface consumed by Custom DPA Handler.
10	ERROR_MISSING_CUSTOM_DPA_HANDLER	Custom DPA handler is enabled in transciever configuration, but there is no handler loaded in the device.
255	STATUS_CONFIRMATION	This code is returned when only a confirmation is received, for example when a message is sent via broadcast.
-1	ERROR_TIMEOUT	No response was received within timeout.
-8	ERROR_IFACE_EXCLUSIVE_ACCESS	The request could not be handled due to exclusive access not being available.

Binary output

Enumerate iqrfBinaryoutput_EnumerateIQRF Standard doc

Schema	Example

Set output iqrfBinaryoutput_SetOutputIQRF Standard doc

Schema	Example

DALI

Send commands iqrfDali_SendCommands

Schema	Example

Send commands asynchronously iqrfDali_SendCommandsAsync

Schema	Example

FRC iqrfDali_Frc

Schema	Example

Light

Enumerate iqrfLight_Enumerate

Schema	Example

Set power iqrfLight_SetPower

Schema	Example

Increment power iqrfLight_IncrementPower

Schema	Example

Decrement power iqrfLight_DecrementPower

Schema	Example

Sensor

Enumerate iqrfSensor_EnumerateIQRF Standard doc

Schema	Example

Read sensors with types iqrfSensor_ReadSensorsWithTypesIQRF Standard doc

Schema	Example

FRC iqrfSensor_FrcIQRF Standard doc

Schema	Example

Embed Explore

Enumerate iqrfEmbedExplore_EnumerateDPA doc

Schema	Example

Peripheral information iqrfEmbedExplore_PeripheralInformationDPA doc

Schema	Example

More peripheral information iqrfEmbedExplore_MorePeripheralsInformationDPA doc

Schema	Example

Embed Coordinator

Address information iqrfEmbedCoordinator_AddrInfoDPA doc

Schema	Example

Get discovered devices iqrfEmbedCoordinator_DiscoveredDevicesDPA doc

Schema	Example

Get bonded devices iqrfEmbedCoordinator_BondedDevicesDPA doc

Schema	Example

Clear all bonds iqrfEmbedCoordinator_ClearAllBondsDPA doc

Schema	Example

Bond node iqrfEmbedCoordinator_BondNodeDPA doc

Schema	Example

Remove bond iqrfEmbedCoordinator_RemoveBondDPA doc

Schema	Example

Discovery iqrfEmbedCoordinator_DiscoveryDPA doc

Schema	Example

Set DPA parameters iqrfEmbedCoordinator_SetDpaParamsDPA doc

Schema	Example

Set hops iqrfEmbedCoordinator_SetHopsDPA doc

Schema	Example

Discovery data iqrfEmbedCoordinator_DiscoveryDataRemoved in DPA v4.0.0

Schema	Example

Backup iqrfEmbedCoordinator_BackupDPA doc

Schema	Example

Restore iqrfEmbedCoordinator_RestoreDPA doc

Schema	Example

Authorize bond iqrfEmbedCoordinator_AuthorizeBondDPA doc

Schema	Example

Read remotely bonded MID iqrfEmbedCoordinator_ReadRemotelyBondedMidRemoved in DPA v4.0.0

Schema	Example

Clear remotely bonded MID iqrfEmbedCoordinator_ClearRemotelyBondedMidRemoved in DPA v4.0.0

Schema	Example

Enable remote bonding iqrfEmbedCoordinator_EnableRemoteBondingRemoved in DPA v4.0.0

Schema	Example

SmartConnect iqrfEmbedCoordinator_SmartConnectDPA doc

Schema	Example

Set MID iqrfEmbedCoordinator_SetMIDDPA doc

Schema	Example

Embed Node

Read iqrfEmbedNode_ReadDPA doc

Schema	Example

Remove bond iqrfEmbedNode_RemoveBondDPA doc

Schema	Example

Backup iqrfEmbedNode_BackupDPA doc

Schema	Example

Restore iqrfEmbedNode_RestoreDPA doc

Schema	Example

Read remotely bonded MID iqrfEmbedNode_ReadRemotelyBondedMidRemoved in DPA v4.0.0

Schema	Example

Clear remotely bonded MID iqrfEmbedNode_ClearRemotelyBondedMidRemoved in DPA v4.0.0

Schema	Example

Enable remote bonding iqrfEmbedNode_EnableRemoteBondingRemoved in DPA v4.0.0

Schema	Example

Validate bonds iqrfEmbedNode_ValidateBondsDPA doc

Schema	Example

Embed OS

Read iqrfEmbedOs_ReadDPA doc

Schema	Example

Batch iqrfEmbedOs_BatchDPA doc

Schema	Example

Selective batch iqrfEmbedOs_SelectiveBatchDPA doc

Schema	Example

Reset iqrfEmbedOs_ResetDPA doc

Schema	Example

Restart iqrfEmbedOs_RestartDPA doc

Schema	Example

Run RFPGM iqrfEmbedOs_RfpgmDPA doc

Schema	Example

Set security iqrfEmbedOs_SetSecurityDPA doc

Schema	Example

Sleep iqrfEmbedOs_SleepDPA doc

Schema	Example

Load code iqrfEmbedOs_LoadCodeDPA doc

Schema	Example

Read configuration iqrfEmbedOs_ReadCfgDPA doc

Schema	Example

Write configuration iqrfEmbedOs_WriteCfgDPA doc

Schema	Example

Write configuration byte iqrfEmbedOs_WriteCfgByteDPA doc

Schema	Example

Test RF signal iqrfEmbedOs_TestRfSignalDPA doc

Schema	Example

Factory settings iqrfEmbedOs_FactorySettingsDPA doc

Schema	Example

Indicate iqrfEmbedOs_IndicateDPA doc

Schema	Example

Embed EEPROM

Read iqrfEmbedEeprom_ReadDPA doc

Schema	Example

Write iqrfEmbedEeprom_WriteDPA doc

Schema	Example

Embed EEEPROM

Read iqrfEmbedEeeprom_ReadDPA doc

Schema	Example

Write iqrfEmbedEeeprom_WriteDPA doc

Schema	Example

Embed RAM

Read iqrfEmbedRam_ReadDPA doc

Schema	Example

Write iqrfEmbedRam_WriteDPA doc

Schema	Example

Embed SPI Removed in DPA v4.15.0

Write and read iqrfEmbedSpi_WriteReadDPA docRemoved in DPA v4.15.0

Schema	Example

Embed LEDR

Set iqrfEmbedLedr_SetDPA doc

Schema	Example

Get iqrfEmbedLedr_GetRemoved in DPA v3.0.3

Schema	Example

Pulse iqrfEmbedLedr_PulseDPA doc

Schema	Example

Flashing iqrfEmbedLedr_FlashingDPA doc

Schema	Example

Embed LEDG

Set iqrfEmbedLedg_SetDPA doc

Schema	Example

Get iqrfEmbedLedg_GetRemoved in DPA v3.0.3

Schema	Example

Pulse iqrfEmbedLedg_PulseDPA doc

Schema	Example

Flashing iqrfEmbedLedg_FlashingDPA doc

Schema	Example

Embed IO

Direction iqrfEmbedIo_DirectionDPA doc

Schema	Example

Set iqrfEmbedIo_SetDPA doc

Schema	Example

Get iqrfEmbedIo_GetDPA doc

Schema	Example

Embed Thermometer

Read iqrfEmbedThermometer_ReadDPA doc

Schema	Example

Embed UART

Open iqrfEmbedUart_OpenDPA doc

Schema	Example

Close iqrfEmbedUart_CloseDPA doc

Schema	Example

Write and read iqrfEmbedUart_WriteReadDPA doc

Schema	Example

Clear, write and read iqrfEmbedUart_ClearWriteReadDPA doc

Schema	Example

Embed FRC

Send iqrfEmbedFrc_SendDPA doc

Schema	Example

Extra result iqrfEmbedFrc_ExtraResultDPA doc

Schema	Example

Send selective iqrfEmbedFrc_SendSelectiveDPA doc

Schema	Example

Set parameters iqrfEmbedFrc_SetParamsDPA doc

Schema	Example

IQMESH Network

Services that ease the task of working with IQMESH network.
They are composed of more than single DPA transaction (request-confirmation-response) in most of the cases, for that reason, the IQMESH services attempt to acquire exclusive access to DPA interface to ensure network consistency.
They are also integrating information from IQRF Repository.
They are inspired by the services available in IQRF IDE - IQMESH Network Manager.

IQRF Bonding

Bond node locally iqmeshNetwork_BondNodeLocal

Schema	Example

SmartConnect iqmeshNetwork_SmartConnect

Schema	Example

Remove bond iqmeshNetwork_RemoveBond

Schema	Example

Remove bond only from coordinator iqmeshNetwork_RemoveBondOnlyInC

Schema	Example

AutoNetwork iqmeshNetwork_AutoNetwork

Schema	Example

IQRF Enumeration

Enumerate device iqmeshNetwork_EnumerateDevice

Schema	Example

IQRF Configuration

Read TR configuration iqmeshNetwork_ReadTrConf

Schema	Example

Write TR configuration iqmeshNetwork_WriteTrConf

Schema	Example

IQRF Backup and Restore

Backup iqmeshNetwork_Backup

Schema	Example

Restore iqmeshNetwork_Restore

Schema	Example

IQRF OTA

Upload iqmeshNetwork_OtaUpload

Schema	Example

Daemon Management

Common status codes

Code	Message	Description
0	ok	Request has been handled successfully.
-1	--	The request failed, refer to the statusStr property for details of failure.

Exit mngDaemon_Exit

Schema	Example

Mode mngDaemon_Mode

Schema	Example

Version mngDaemon_Version

Schema	Example

Daemon Configuration

Common status codes

Code	Message	Description
0	ok	Request has been handled successfully.
-1	--	The request failed, refer to the statusStr property for details of failure.

Component cfgDaemon_Component

Schema	Example

Daemon Scheduler

Common status codes

Code	Message	Description
0	ok	Request has been handled successfully.
-1	--	The request failed, refer to the statusStr property for details of failure.

Add task mngScheduler_AddTask

Schema	Example

Get task mngScheduler_GetTask

Schema	Example

List tasks mngScheduler_List

Schema	Example

Remove all tasks mngScheduler_RemoveAll

Schema	Example

Remove task mngScheduler_RemoveTask

Schema	Example

Daemon Metadata

Set metadata mngMetaData_SetMetaData

Schema	Example

Get metadata mngMetaData_GetMetaData

Schema	Example

Set MID to metadata mngMetaData_SetMidMetaId

Schema	Example

Get metadata from MID mngMetaData_GetMidMetaData

Schema	Example

Get metadata from NADR mngMetaData_GetNadrMetaData

Schema	Example

Export metadata mngMetaData_ExportMetaDataAll

Schema	Example

Verify metadata mngMetaData_VerifyMetaDataAll

Schema	Example

Import metadata mngMetaData_ImportMetaDataAll

Schema	Example

Import NADR-MID map mngMetaData_ImportNadrMidMap

Schema	Example

Export NADR-MID map mngMetaData_ExportNadrMidMap

Schema	Example

Daemon Notification

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

Monitor ntfDaemon_Monitor

Schema	Example