IQRF DPA Framework - Technical Guide

Contents
Topics
Search

1 Introduction
2 Basics
- 2.1 Device types
- 2.2 RF Modes
- 2.3 Interfaces
- 2.4 DPA Plug-in filename
- 2.5 Message parameters
- 2.6 DPA Messages
- 2.7 Device exploration
  - 2.7.1 Peripheral enumeration
    - 2.7.1.1 Source code support
  - 2.7.2 Get peripheral information
    - 2.7.2.1 Source code support
  - 2.7.3 Get information for more peripherals
    - 2.7.3.1 Source code support
3 Peripherals
- 3.1 Standard operations in general
  - 3.1.1 Writing to peripheral
    - 3.1.1.1 Source code support
  - 3.1.2 Reading from peripheral
    - 3.1.2.1 Source code support
- 3.2 Coordinator
  - 3.2.1 Peripheral information
  - 3.2.2 Get addressing information
    - 3.2.2.1 Source code support
  - 3.2.3 Get discovered nodes
  - 3.2.4 Get bonded nodes
    - 3.2.4.1 Source code support
  - 3.2.5 Clear all bonds
  - 3.2.6 Bond node
    - 3.2.6.1 Source code support
  - 3.2.7 Remove bonded node
    - 3.2.7.1 Source code support
  - 3.2.8 Re-bond node
    - 3.2.8.1 Source code support
  - 3.2.9 Discovery
    - 3.2.9.1 Source code support
  - 3.2.10 Set DPA Param
    - 3.2.10.1 Source code support
  - 3.2.11 Set Hops
    - 3.2.11.1 Source code support
  - 3.2.12 Discovery data
    - 3.2.12.1 Source code support
  - 3.2.13 Backup
    - 3.2.13.1 Source code support
  - 3.2.14 Restore
    - 3.2.14.1 Source code support
  - 3.2.15 Authorize bond
    - 3.2.15.1 Source code support
  - 3.2.16 Enable remote bonding
  - 3.2.17 Read remotely bonded module ID
  - 3.2.18 Clear remotely bonded module ID
- 3.3 Node
  - 3.3.1 Peripheral information
  - 3.3.2 Read
    - 3.3.2.1 Source code support
  - 3.3.3 Remove bond
  - 3.3.4 Enable remote bonding
    - 3.3.4.1 Source code support
  - 3.3.5 Read remotely bonded module ID
    - 3.3.5.1 Source code support
  - 3.3.6 Clear remotely bonded module ID
  - 3.3.7 Remove bond address
  - 3.3.8 Backup
  - 3.3.9 Restore
- 3.4 OS
  - 3.4.1 Peripheral information
  - 3.4.2 Read
    - 3.4.2.1 Source code support
  - 3.4.3 Reset
  - 3.4.4 Restart
  - 3.4.5 Read HWP configuration
    - 3.4.5.1 Source code support
  - 3.4.6 Write HWP configuration
    - 3.4.6.1 Source code support
  - 3.4.7 Write HWP configuration byte
    - 3.4.7.1 Source code support
  - 3.4.8 Run RFPGM
  - 3.4.9 Sleep
    - 3.4.9.1 Source code support
  - 3.4.10 Set Security
    - 3.4.10.1 Source code support
  - 3.4.11 Batch
  - 3.4.12 Selective Batch
    - 3.4.12.1 Source code support
  - 3.4.13 LoadCode
    - 3.4.13.1 Source code support
- 3.5 EEPROM
- 3.6 EEEPROM
- 3.7 RAM
  - 3.7.1 Peripheral information
  - 3.7.2 Read & Write
    - 3.7.2.1 Source code support
- 3.8 SPI (Slave)
  - 3.8.1 Peripheral information
  - 3.8.2 Write & Read
- 3.9 LED
- 3.10 IO
  - 3.10.1 Peripheral information
  - 3.10.2 Direction
    - 3.10.2.1 Source code support
  - 3.10.3 Set
    - 3.10.3.1 Source code support
  - 3.10.4 Get
- 3.11 Thermometer
  - 3.11.1 Peripheral information
  - 3.11.2 Read
    - 3.11.2.1 Source code support
- 3.12 PWM
  - 3.12.1 Peripheral information
  - 3.12.2 Set
    - 3.12.2.1 Source code support
- 3.13 UART
  - 3.13.1 Peripheral information
  - 3.13.2 Open
    - 3.13.2.1 Source code support
  - 3.13.3 Close
  - 3.13.4 Write & Read
    - 3.13.4.1 Source code support
  - 3.13.1 Clear & Write & Read
- 3.14 FRC
  - 3.14.1 Peripheral information
  - 3.14.2 Send
    - 3.14.2.1 Source code support
  - 3.14.3 Extra result
  - 3.14.4 Send Selective
    - 3.14.4.1 Source code support
  - 3.14.5 Set FRC Params
    - 3.14.5.1 Source code support
  - 3.14.6 Embedded FRC Commands
    - 3.14.6.1 Prebonding
    - 3.14.6.2 UART or SPI data available
    - 3.14.6.3 Acknowledged broadcast - bits
    - 3.14.6.4 Read temperature
    - 3.14.6.5 Acknowledged broadcast - bytes
    - 3.14.6.6 Memory read
    - 3.14.6.7 Memory read plus 1
    - 3.14.6.8 FRC response time
4 HWP Configuration
5 Device Startup
6 Autoexec
7 IO Setup
8 Custom DPA Handler
- 8.1 Handler Example
- 8.2 Events Flow
  - 8.2.1 Coordinator
  - 8.2.2 Node
  - 8.2.3 General events
    - 8.2.3.1 Interrupt
    - 8.2.3.2 Disable Interrupts
    - 8.2.3.3 Sleep Events
- 8.3 Events
  - 8.3.1 Interrupt
  - 8.3.2 Idle
  - 8.3.3 Init
  - 8.3.4 Notification
  - 8.3.5 AfterRouting
  - 8.3.6 BeforeSleep
  - 8.3.7 AfterSleep
  - 8.3.8 Reset
  - 8.3.9 Disable Interrupts
  - 8.3.10 FrcValue
  - 8.3.11 FrcResponseTime
  - 8.3.12 ReceiveDpaResponse
  - 8.3.13 IFaceReceive
  - 8.3.14 ReceiveDpaRequest
  - 8.3.15 BeforeSendingDpaResponse
  - 8.3.16 PeerToPeer
  - 8.3.17 AuthorizePreBonding
  - 8.3.18 UserDpaValue
  - 8.3.19 BondingButton
  - 8.3.20 DPA Request
    - 8.3.20.1 Enumerate Peripherals
    - 8.3.20.2 Get Peripheral Info
    - 8.3.20.3 Handle Peripheral Request
    - 8.3.20.4 Alternative Event Processing
- 8.4 DPA API
- 8.5 DPA API Variables
  - 8.5.1 bit ProvidesRemoteBonding
  - 8.5.2 uns8 RemoteBondingCount
  - 8.5.3 bit IFaceMasterNotConnected
  - 8.5.4 bit NodeWasBonded
  - 8.5.5 bit EnableIFaceNotificationOnRead
  - 8.5.6 uns16 DpaTicks
  - 8.5.7 uns8 LPtoutRF
  - 8.5.8 uns8 ResetType
  - 8.5.9 bit DSMactivated
  - 8.5.10 uns8 UserDpaValue
  - 8.5.11 uns8 NetDepth
  - 8.5.12 bit LpRxPinTerminate
- 8.6 Examples
  - 8.6.1 Bonding
  - 8.6.2 AutoNetwork & Coordinator-AutoNetwork-Embedded
  - 8.6.3 Coordinator-FRCandSleep
  - 8.6.4 FRC-Minimalistic
  - 8.6.5 LED-MemoryMapping
  - 8.6.6 PeripheralMemoryMapping
  - 8.6.7 UserPeripheral-18B20
  - 8.6.8 UserPeripheral-18B20-Idle
  - 8.6.9 UserPeripheral-ADC
  - 8.6.10 UserPeripheral-HW-UART
  - 8.6.11 UserPeripheral-i2c
  - 8.6.12 UserPeripheral-PWM
  - 8.6.13 UserPeripheral-SPImaster
9 DPA in Practice
10 Constants
- 10.1 Peripheral Numbers
- 10.2 Response Codes
- 10.3 DPA Commands
- 10.4 Peripheral Types
- 10.5 Custom DPA Handler Events
- 10.6 Extended Peripheral Characteristic
- 10.7 HW Profile IDs
- 10.8 Baud rates
- 10.9 User FRC Codes
11 Appendix
- 11.1 CRC Calculation
- 11.2 One’s Complement Fletcher-16 Checksum Calculation
  - 11.2.1 CC5X Compiler
  - 11.2.2 C#
- 11.3 Custom DPA Handler Code at .hex File
- 11.4 IQRF OS Change
  - 11.4.1 IQRF OS Change File
- 11.5 Code Optimization
  - 11.5.1 W as a temporary variable
  - 11.5.2 Variable access reorder
  - 11.5.3 Variable access decomposition
  - 11.5.4 Explicit MOVLB omitting
  - 11.5.5 Direct function parameter usage
  - 11.5.6 Avoiding else
  - 11.5.7 Switch instead of if
  - 11.5.8 Function call before return
  - 11.5.9 Using goto to avoid redundant code
  - 11.5.10 Avoiding readFromRAM and getINDFx
  - 11.5.11 Advanced C-compiler optimized instructions
  - 11.5.12 do {} while () is preferred
  - 11.5.13 Use DECFSZ/INCFSZ
  - 11.5.14 Widening function parameter
  - 11.5.15 Carry as a variable
  - 11.5.16 Limiting variable scope
  - 11.5.17 Using IQRF variables
  - 11.5.18 Parameter mapped to W
  - 11.5.19 Pointer parameters mapped to FSRx
  - 11.5.20 FSRx as 16-bit variable
  - 11.5.21 Using FSRx to copy between buffers and variables
  - 11.5.22 Accessing 16-bit MCU registers
  - 11.5.23 Using IQRF OS offset and limit variables
  - 11.5.24 Effective is not always effective
  - 11.5.25 Assignment also have a value
  - 11.5.26 Interval detection optimization
  - 11.5.27 Optimized constants
  - 11.5.28 Equality result
  - 11.5.29 One instruction at if branch
  - 11.5.30 Utilization of the preloaded W
  - 11.5.31 == 1 is more effective than != 1
  - 11.5.32 == 0xFF is more effective than != 0xFF
  - 11.5.33 Expression modification
  - 11.5.34 Computed goto with a table limit
  - 11.5.35 Default is first at switch
  - 11.5.36 Better to return from than after the loop
  - 11.5.37 Modification instead of storing value
  - 11.5.38 Assignment compares to 0
  - 11.5.39 End condition of 16-bit loop variable
  - 11.5.40 Shift for a smart comparison
  - 11.5.41 Optimized return TRUE/FALSE
  - 11.5.42 Avoiding MOVLP #1
  - 11.5.43 Avoiding MOVLP #2
  - 11.5.44 Setting zeroed variables
  - 11.5.45 Compare to zero is more effective
  - 11.5.46 setFSR01
12 DPA Release Notes
- 12.1 DPA 3.01
- 12.2 DPA 3.00
- 12.3 DPA 2.28
- 12.4 DPA 2.27
- 12.5 DPA 2.26
- 12.6 DPA 2.24
- 12.7 DPA 2.23
- 12.8 DPA 2.22
- 12.9 DPA 2.21
- 12.10 DPA 2.20
- 12.11 DPA 2.13
- 12.12 DPA 2.12
- 12.13 DPA 2.11
- 12.14 DPA 2.10
- 12.15 DPA 2.01
- 12.16 DPA 2.00
13 Document Revisions