How it Works
IMST
Loading...
WIMOD404530
User Manual
44 pgs715.69 Kb0

IMST WIMOD404530 User Manual

Download
WiMOD - iM222A
UserManual Version 1.1
Document ID: 4100/6404/0056
IMST GmbH
Carl-Friedrich-Gauss-Str. 2
D-47475 Kamp-Lintfort
Document Information
File name Created Total pages
iM222A_UserManual
2012-12-07
44
Revision History
Version Change
1.0 Initial version.
1.1 FCC and IC statement added
Aim of this document
This document is intended to provide help using the iM222A radio module. It describes the user interface and includes a basic hardware integration guide.
iM222A_UserManual, Wireless Solutions, V1.1 page 2 of 44
Table of Contents
1SUMMARY / INTRODUCTION 6
1.1Overview 6
2WIMOD HCI COMMUNICATION 7
2.1Message Flow 7
2.2WiMOD HCI Message Format 8
2.3Elements of the WiMOD HCI Message 9
2.3.1 Type Field (8 bits) 9
2.3.1.1Type Information Field (3 bits) 9
2.3.1.2Address Field (5 bits) 9
2.3.2 Control Field (8 bit) 10
2.3.2.1Status Information Field (2 bits) 10
2.3.3 Destination ID (8 bit) 10
2.3.4 Source ID (8 bit) 10
2.3.5 Opcode Field (8 bit) 11
2.3.6 Length Field (8 bit) 11
2.3.7 Payload (0 ... max. octets) 11
3COMMON SERVICES 12
3.1Device Management Services 12
3.1.1 Ping 13
3.1.2 Reset 14
3.1.3 Device Information 15
3.1.3.1Get Device Information 15
3.1.3.2Device Information Field 16
3.1.4 Device Configuration 17
3.1.4.1Device Parameter 17
iM222A_UserManual, Wireless Solutions, V1.1 page 3 of 44
3.1.4.2
Get Device Parameter 18
3.1.4.3Set Device Parameter 19
3.1.4.4Device Parameter Field 20
3.1.4.5Factory Reset 21
3.1.5 System Operation Modes 22
3.1.5.1Set Next Operation Mode 22
3.1.5.2Get System Operation Mode 23
3.1.5.3System Operation Modes 23
3.1.6 RF Ping 24
3.1.7 Peer Device Information 25
3.1.8 Peer Device Configuration 26
3.1.8.1Get Peer Device Parameter 26
3.1.8.2Set Peer Device Parameter 27
3.2RF Data Exchange Services 28
3.2.1 Unreliable Data Request 28
3.2.2 Acknowledged Data Request 30
4GLOBAL SYSTEM PARAMETER 32
4.1Global Module Identifier 32
4.2Global System Endpoint Identifier 32
5COMMUNICATION OVER UART 33
5.1Physical Parameters 33
6HARDWARE INTEGRATION GUIDE 34
6.1Typical Application Schematic 34
6.2PCB Design Recommendation 35
6.3Module Dimension 36
6.4Recommended Footprint 36
6.5Recommended Soldering Conditions 37
iM222A_UserManual, Wireless Solutions, V1.1 page 4 of 44
7
ADDITIONAL DOCUMENTATION 38
8PACKAGING INFORMATION 39
8.1Carrier Tape Information 39
8.2Reel Information 39
9ORDERING INFORMATION 40
10APPENDIX 40
10.1List of Abbreviations 40
10.2List of Figures 41
10.3References 41
11REGULATORY COMPLIANCE INFORMATION 42
12IMPORTANT NOTICE 44
12.1Disclaimer 44
12.2Contact Information 44
iM222A_UserManual, Wireless Solutions, V1.1 page 5 of 44
1 Summary / Introduction
This document specifies its WiMOD Host Controller Interface (HCI) Protocol and includes the hardware integration guide of the radio module. For additional information about programming and software development for the iM222A please read application note “iM222A_AN001_SW­Development”.
1.1 Overview
The WiMOD HCI Protocol is designed to expose the WiMOD Radio Services to an external Host Controller. The communication between Host and WiMOD is based on so called HCI Messages which can be sent through an UART (see Fig.1). The interface and communication protocol is common to all WiMODs and provides many services for configuration and RF data exchange.
Figure 1-1: Host Controller Communication
iM222A_UserManual, Wireless Solutions, V1.1 page 6 of 44
2 WiMOD HCI Communication
2.1 Message Flow
The WiMOD HCI Protocol defines three different types of messages which are exchanged between Host Controller and WiMOD Controller:
1. Command Message: always sent from Host Controller to WiMOD Controller to trigger a
function.
2. Response Message: sent from WiMOD Controller to Host Controller to answer a
preceding HCI Command Message
3. Event Message: can be sent from WiMOD Controller to Host Controller at any time
Figure 2-1: HCI Message Flow
iM222A_UserManual, Wireless Solutions, V1.1 page 7 of 44
2.2 WiMOD HCI Message Format
The communication between a WiMOD device and a host device is realized by means of the following message format.
Figure 2-2: WiMOD HCI Message
This message format is used to call services and exchange information. The message transmission starts with the Type Field and ends with the last byte of the Payload Field. Note: the Payload Field might be empty.
The WiMOD HCI Message requires a reliable transport layer and does not provide any kind of error checks or frame synchronisation means. More details about message transfer over UART is given in Chapter 5.
Note: The UART Interface as described in Chapter 5 is the standard Host Controller Interface of the WiMODs.
iM222A_UserManual, Wireless Solutions, V1.1 page 8 of 44
2.3 Elements of the WiMOD HCI Message
This chapter describes the message format in detail.
2.3.1 Type Field (8 bits)
The Type Field is used to distinguish between the different message types. This field is subdivided into a Type Information Field and an Address Field.
Figure 2-3: Type Field
2.3.1.1 Type Information Field (3 bits)
Value Typ e Description
000b Command Frame Send from Host to WiMOD device to call a function. 001b Response Frame Send from WiMOD device to Host in consequence of a
command frame.
010b Event Frame Send from WiMOD device to Host without a preceding
command frame to indicate a system state or to pass an
information element. 011b Reserved This Type is reserved. 1xxb Reserved These combinations are reserved for special purposes and
must not be set for application services.
2.3.1.2 Address Field (5 bits)
The Address Field is reserved for future extensions and must be set to zero 00000b.
iM222A_UserManual, Wireless Solutions, V1.1 page 9 of 44
2.3.2 Control Field (8 bit)
The function of this field depends on the message type:
Command Message Format
This field is set to zero 0x00 for all command frames.
Event Message Format
This field is set to zero 0x00 for all event frames.
Response Message Format
Within a Response Message the Control Field contains status information about the preceding command within the two least significant bits. The status field has to be checked prior to any other following field.
Figure 2-4: Control Field
2.3.2.1 Status Information Field (2 bits)
Value Description
00b Command failed 01b Command successful 10b Command not supported 11b Reserved
2.3.3 Destination ID (8 bit)
This field identifies a logical destination endpoint within a device. The value must be unique for all nodes within one application.
2.3.4 Source ID (8 bit)
This field identifies the logical source endpoint within a device. The value must be unique for all nodes within one application.
iM222A_UserManual, Wireless Solutions, V1.1 page 10 of 44
2.3.5 Opcode Field (8 bit)
This field contains the opcode number which triggers a dedicated service function of a given endpoint. Opcode values must only be unique within one single endpoint. The value 0x00 is reserved.
2.3.6 Length Field (8 bit)
The Length Field contains the size of the following Payload Field. The size is given as number of octets. Note: The Payload Length could be zero.
2.3.7 Payload (0 ... max. octets)
The Payload Field contains service / function dependent data. The size depends on the given Firmware.
Note: The “AppStarterKit” firmware provides a maximum payload field of 128 octets.
iM222A_UserManual, Wireless Solutions, V1.1 page 11 of 44
3 Common Services
This chapter outlines the message format for the common WiMOD services. The functions are ordered according to their corresponding endpoint. The global endpoint identifiers are listed in chapter “Global System Identifier”.
3.1 Device Management Services
The Device Management services are accessible through endpoint identifier DEVMGMT_ID (see chapter “Global System Identifier”). The following services are available:
Ping Reset Device Information Device Configuration System Operation Modes RF Ping Peer Device Information Peer Device Configuration
iM222A_UserManual, Wireless Solutions, V1.1 page 12 of 44
3.1.1 Ping
This command is used to check if the connected device is alive. The sender should expect a Ping Response within a certain time interval.
Message Flow
Figure 3-1: Ping
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x01 Ping Request Length 0 No payload
Response Message
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding Ping Request
command SrcID DEVMGMT_ID Source EP identifier Opcode 0x02 Ping Response Length 0 No payload
iM222A_UserManual, Wireless Solutions, V1.1 page 13 of 44
3.1.2 Reset
This message can be used to reset a WiMOD. The reset will be performed after approx. 500ms.
Message Flow
Host
Controller
HCI_Cmd(ResetReq)
HCI_Rsp(ResetRsp)
WiMOD
Controller
StartTimer
Timer_Expired
SW Reset
Figure 3-2: Reset Request
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x29 Reset Request Length 0 No Payload
WiMOD
Timer
Response Message
This message acknowledges the Reset Request message.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding
Request command. SrcID DEVMGMT_ID Source EP identifier Opcode 0x2A Reset Response Length 0 No Payload
iM222A_UserManual, Wireless Solutions, V1.1 page 14 of 44
3.1.3 Device Information
The WiMOD Firmware provides a service to readout some information elements for identification purposes.
3.1.3.1 Get Device Information
This service can be used to identify the local connected device. As a result the device sends a response message which contains a Device Information Field.
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x05 Get Device Information Request Length 0 No payload
Response Message
This message contains the Device Information Field which is described below.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from the
preceding Request command.
SrcID DEVMGMT_ID Source EP identifier
Opcode 0x06 Get Device Information Response Length sizeof(DEVIDE_INFO_FIELD) Size of Device Information Field Payload […] DEVICE_INFO_FIELD Device Information Field
iM222A_UserManual, Wireless Solutions, V1.1 page 15 of 44
3.1.3.2 Device Information Field
The Device Information Field contains the following elements:
Offset Content
0x00 0x01
0x02 Module Type (8 Bit)
0x03 Device Mode (8 Bit)
0x04 Firmware Version Number (8 Bit)
0x05 HCIProtocolVersion (8 Bit)
Device Address (16 Bit)
- used to address a certain device via RF link Device Address (Bits 0…7) Device Address (Bits 8…15)
- identifies the type of module (see Appendix B)
- identifies the configured device mode:
The firmware provides different RF operation modes: 0 = End Device (Default Configuration) 1 = Reserved 2 = Repeater: device which simply retransmits every received message 3 = Sniffer: sends every received message to its connected host
- identifies the programmed firmware: Bits 7..4 -> major FW Version number Bits 3..0 -> minor FW Version number Example: 0x14 -> FW Version = 1.4
This value identifies the version of the implemented HCI protocol. It will be incremented due to an update on Firmware side so that the Host is able to detect an incompatibility.
Example
A Device Information Field which includes the Device Address (0x1234) of an iM820A End Device with Firmware Version 1.3 and HCI Protocol Version 1 looks as follows:
1. Byte 2.Byte 3.Byte 4.Byte 5.Byte 6. Byte
LOBYTE(DevAddr) HIBYTE(DevAddr) Module Type Device Mode FW Version HCI Version 0x34 0x12 0x01 0x00 0x13 0x01
The payload size is 6 bytes in this case.
iM222A_UserManual, Wireless Solutions, V1.1 page 16 of 44
3.1.4 Device Configuration
The Firmware provides several configurable system parameters which are stored in none volatile memory. These configuration parameters are readout during start-up to configure the firmware components and hardware units.
3.1.4.1 Device Parameter
The following parameters are available on all WiMODs but their range and physical meaning is WiMOD device specific.
Parameter Description
RF_DataRate Index for RF Datarate, only 250kbps available RF_PowerLevel Index for RF Powerlevel, 0 := -22dBm ... 15 := 4,5dBm RF_Channel Index for RF Channel, 11 := 2405MHz ... 26:= 2480MHz
The next table outlines parameters which have the same meaning on all WiMOD devices:
Parameter Description
NetworkAddress (8 Bit)
DeviceAddress (16 Bit)
DeviceMode ( 8 Bit)
AckNumRetries (8 Bit)
A Network Address is used to separate groups of WiMODs from each other. A device accepts RF messages which contain its own Network Address or the BROADCAST_NETWORK_ADDRESS (0xFF). Valid range: 0x01 – 0xFE The values 0x00 and 0xFF are reserved. Note: Sniffer devices perform no Network Address filtering and must set the NetworkAddress to 0xFF
The Device Address is used to address a certain device within a group of devices with same RF settings. Therefore the device address must be set to a unique value to ensure proper operation.
A device accepts RF messages which contain its own configured Device Address or the BROADCAST_DEVICE_ADDRESS (0xFFFF). Valid range: 0x0001 – 0xFFFE
The values 0 and 0xFFFF are reserved. Note: Repeater devices and Sniffer devices perform no Device Address filtering
The firmware provides different RF operation modes: 0 = End Device (Default Configuration): a standard device with no specific function 1 = Reserved
2 = Reserved 3 = Reserved
Defines the maximum number of retransmissions for RF messages which are send by means of the Acknowledged Data Exchange Service
iM222A_UserManual, Wireless Solutions, V1.1 page 17 of 44
AckTimeoutTicks (8 Bit)
Defines the timeout window (in 10ms ticks) the sender is waiting for an ACK message before a retransmission is initiated
3.1.4.2 Get Device Parameter
This command can be used to read several device parameters.
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x09 Get Device Parameter Request Length 0 No Payload
Response Message
This message contains the Device Parameter Field which is described below.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from
preceding Request command. SrcID DEVMGMT_ID Source EP identifier Opcode 0x0A Get Device Parameter Response
Length Variable size of Device Parameter Field Payload […] DEVICE_PARAM_FIELD Device Parameter Field
iM222A_UserManual, Wireless Solutions, V1.1 page 18 of 44
3.1.4.3 Set Device Parameter
This command can be used to change several device parameters. The new settings get valid after a system reset (see Reset Request) of the connected WiMOD. The Parameter Field is described in detail below.
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x0B Set Device Parameter Request Length variable Size of Device Parameter Field Payload […] DEVICE_PARAM_FIELD Device Parameter Field
Response Message
This message acknowledges the Set Device Parameter Request.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding
Request command. SrcID DEVMGMT_ID Source EP identifier Opcode 0x0C Set Device Parameter Response Length 0 No Payload
iM222A_UserManual, Wireless Solutions, V1.1 page 19 of 44
3.1.4.4 Device Parameter Field
The Device Parameter Field is a variable Information Element which is able to carry a complete list of Device Parameter. A preceding Information Indicator Flag indicates the exact content of the following list. If an Information Indicator Bit is set the corresponding Parameter is attached. The Indicator Flag must be parsed starting with Bit 0.
Offset Content
0x00 Information Indicator Flag:
Bit field: 0000 0001b -> Network Address
0000 0010b -> Device Address 0000 0100b -> RF Data Rate 0000 1000b -> RF Power Level 0001 0000b -> RF Channel 0010 0000b -> Device Mode 0100 0000b -> Number of retries for acknowledged data exchange service
1000 0000b -> Timeout window for expected ACK 0x01 NetworkAddress (8 Bit) Variable DeviceAddress (16 Bit) variable RF_DataRate (8 Bit) variable RF_PowerLevel (8 Bit) variable RF_Channel (8 Bit) variable DeviceMode (8 Bit) variable AckNumRetries (8 Bit) variable AckTimeoutTicks (8 Bit)
Note: The specific values for RF Data Rate, RF Power Level and RF Channel and the physical meaning are presented in the WiMOD specific documents [3].
Example
A Device Parameter Element which includes the Device Address (0x1234) and RF Channel (0x02) looks as follows:
1. Byte 2.Byte 3.Byte 4. Byte
IIFlag LOBYTE(DevAddr) HIBYTE(DevAddr) RF Channel 0x12 0x34 0x12 0x02
The payload size is 4 bytes in this case.
iM222A_UserManual, Wireless Solutions, V1.1 page 20 of 44
3.1.4.5 Factory Reset
This message can be used to reset the device parameters. All parameters except the Device Address will be set to default factory settings. A resetFlag parameter defines if a system reset should be initiated or not. The reset will be executed after approx. 500ms
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x27 Factory Reset Request Length 1 Size of payload Payload[0] resetFlag 0: no reset
1: perform system reset
Response Message
This message acknowledges the Factory Reset Request message.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding
Request command. SrcID DEVMGMT_ID Source EP identifier Opcode 0x28 Factory Reset Response Length 0 No Payload
iM222A_UserManual, Wireless Solutions, V1.1 page 21 of 44
3.1.5 System Operation Modes
The firmware supports different kind of System Operation Modes to align its behaviour according to a certain use case e.g. Test Mode, Application Mode. The System Operation Mode is determined during start-up and requires a reset to get changed.
3.1.5.1 Set Next Operation Mode
This message can be used to set the next System Operation Mode. A password is required to perform the change. A resetFlag can be set to initiate an automatic system reset. The system reset will be executed after approx. 500ms.
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x1B Set System Operation Mode Request Length 10 Size of payload Payload[0..7] Password Payload[8] Next Operation Mode 8 Bit value, see below for details Payload[9] resetFlag 0: no reset
1: perform system reset
Response Message
This message acknowledges the Set System Operation Mode message.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding
Request command. SrcID DEVMGMT_ID Source EP identifier Opcode 0x1C Set System Operation Mode Response Length 0 No Payload
iM222A_UserManual, Wireless Solutions, V1.1 page 22 of 44
3.1.5.2 Get System Operation Mode
This service can be used to readout the current System Operation Mode.
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x1D Get System Operation Mode Request Length 0 No payload
Response Message
This message contains the current System Operation Mode.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding
Request command. SrcID DEVMGMT_ID Source EP identifier Opcode 0x1E Get System Operation Mode Response Length 1 Size of Payload Payload[0] System Operation Mode 8 Bit value, see below for details
3.1.5.3 System Operation Modes
The following System Operation Modes are supported:
Value Description
0 Standard Application Mode / Default Mode 1 Hardware Test Mode 2 Production Mode 3 Self test Mode
iM222A_UserManual, Wireless Solutions, V1.1 page 23 of 44
3.1.6 RF Ping
This service is used to check via RF link if a peer device is alive. The Payload Field of this message contains a 16-Bit destination/peer device address which is used to address a certain WiMOD in range. The device address is a unique value from 0x0001 to 0xFFFE. The values 0x0000 and 0xFFFF are reserved for special purposes. The later one is used as BROADCAST_DEVICE_ADDRESS for broadcast services via RF link. The local WiMOD Controller converts the incoming HCI command into a RF message which is sent over the air. If a WiMOD device with matching Device Address is in range, it answers with a corresponding RF Ping Response message which will finally be forwarded to the Host controller. If no WiMOD device answers, no response message will be generated.
Message Flow
Host
Controller
HCI_Cmd(RF_PingReq, PeerAddr)
HCI_Rsp(RF_PingRsp, PeerAddr)
WiMOD
Controller (SrcAddr)
RF_Msg(PeerAddr, SrcAddr, RF_PingReq)
RF_Msg(SrcAddr, PeerAddr, RF_PingRsp)
Figure 3-3: RF Ping
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x03 RF Ping Request Length 2 Payload Length Payload[0]
Payload[1]
Device Address [Bits 0…7] Device Address [Bits 8…15]
Destination/Peer Device Address
WiMOD
Controller
(PeerAddr)
iM222A_UserManual, Wireless Solutions, V1.1 page 24 of 44
Response Message
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding Ping
Request command SrcID DEVMGMT_ID Source EP identifier Opcode 0x04 RF Ping Response Length 2 Payload Length Payload[0]
Payload[1]
Device Address [Bits 0…7] Device Address [Bits 8…15]
Source Device Address
3.1.7 Peer Device Information
The service can be used to get information from a peer device via RF link.
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x07 Get Peer Device Information Request Length 2 Payload[0]
Payload[1]
Device Address [Bits 0…7] Device Address [Bits 8…15]
Destination Device Address
Response Message
This message contains the Device Information Field from the peer device.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from the
preceding Request command.
SrcID DEVMGMT_ID Source EP identifier
Opcode 0x08 Get Device Information Request Length sizeof(DEVIDE_INFO_FIELD) Size of Device Information Field Payload […] DEVICE_INFO_FIELD Device Information Field
Note: The Device Information Field is the same as described in chapter Device Information.
iM222A_UserManual, Wireless Solutions, V1.1 page 25 of 44
3.1.8 Peer Device Configuration
This service allows configuring a peer device via RF link. The list of configurable parameters is described in chapter Device Configuration.
3.1.8.1 Get Peer Device Parameter
This command can be used to read several device parameters from a peer device.
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x0D Get Peer Device Parameter Request Length 2 Payload Length Payload[0]
Payload[1]
Device Address [Bits 0…7] Device Address [Bits 8…15]
Destination Device Address
Response Message
This message contains the Device Parameter Field of the peer device.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from
preceding Request command. SrcID DEVMGMT_ID Source EP identifier Opcode 0x0E Get Peer Device Parameter Response
Length variable size of Device Parameter Field Payload […] DEVICE_PARAM_FIELD Device Parameter Field
Note: The Device Parameter Field is the same as described in chapter Device Configuration.
iM222A_UserManual, Wireless Solutions, V1.1 page 26 of 44
3.1.8.2 Set Peer Device Parameter
This command can be used to change several parameters on the peer device. The new settings get valid after a system reset.
Command Message
Field Content Comment
DstID DEVMGMT_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x0F Set Peer Device Parameter Request Length Variable Payload[0]
Payload[1] Payload […] DEVICE_PARAM_FIELD Device Parameter Field
Device Address [Bits 0…7] Device Address [Bits 8…15]
Destination Device Address
Response Message
This message acknowledges the Set Peer Device Parameter Request.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding
Request command. SrcID DEVMGMT_ID Source EP identifier Opcode 0x10 Set Peer Device Parameter Response Length 1 Payload[0] Status 1: operation successful
0: operation failed
iM222A_UserManual, Wireless Solutions, V1.1 page 27 of 44
3.2 RF Data Exchange Services
The RF Data Exchange services can be used to send data packets from one Host Controller to another one. The services are accessible through endpoint identifier DATALINK_ID (see chapter “Global System Identifier”). The following services are available:
Unreliable Data Request Acknowledged Data Request
3.2.1 Unreliable Data Request
This service can be used to send data packets via RF without acknowledgement from the peer device. The local WiMOD Controller converts the incoming HCI message into a RF message which is sent over the air. If a peer WiMOD Controller is in range it accepts this RF message if the following conditions are valid:
1. the sending and receiving WiMODs have the same physical RF parameter settings:
RF_DataRate, RF_Channel
2. the WiMODs have the same NetworkAddress configuration
3. the RF message contains either the Destination/Peer DeviceAddress of the receiving
WiMOD or the BROADCAST_DEVICE_ADDRESS
The peer Host Controller will receive a HCI event message from the peer WiMOD if the RF transmission was successful. This HCI event message contains the transmitted User Data and the device address of the transmitting WiMOD which is also part of the received RF message.
Message Flow
Figure 3-4: Unreliable Data Request
iM222A_UserManual, Wireless Solutions, V1.1 page 28 of 44
Command Message
Field Content Comment
DstID DATALINK_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x01 Unreliable Data Request Length n, n > 2; n < 114 Variable length Payload[0]
Payload[1] Payload[2…n-1] User Data User Data with n–2 octets
Device Address [Bits 0…7] Device Address [Bits 8…15]
Destination/Peer Device Address
Note: it is possible to send “unreliable” messages as broadcast messages to all WiMODS in range by choosing a destination/peer device address of 0xFFFF which is the reserved BROADCAST_DEVICE_ADDRESS.
Response Message
This is the response message of the local WiMOD device.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding
Request command. SrcID DATALINK_ID Source EP identifier Opcode 0x02 Unreliable Data Response Length 0 No payload
Note: this message doesn’t confirm that the message is sent via RF.
Event Message
This message is send to a Host Controller as a result of a received “Unreliable Data Request” message via RF link. The first two bytes in the payload field contain the source device address of the transmitting WiMOD.
Field Content Comment
DstID DATALINK_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x03 Unreliable Data Indication Length n, n > 2; n < 114 Variable Length Payload[0]
Payload[1] Payload[2…n-1] User Data User Data with n-2 octets
Device Address [Bits 0…7] Device Address [Bits 8…15]
Source Device Address
iM222A_UserManual, Wireless Solutions, V1.1 page 29 of 44
3.2.2 Acknowledged Data Request
This service can be used to send data packets via RF with acknowledgement from the peer WiMOD. If an RF Ack message is not received within a configurable timeout (see Device Configuration) a retransmission of the data packet will be initiated. The maximum number of retransmissions is configurable. On successful transmission the peer Host Controller will receive a HCI event message containing the User Data and source address of the transmitting WiMOD. Furthermore a Response Message is sent back to the transmitting Host Controller which contains the status of the packet transmission.
Note: RF retransmissions will be initiated even if only the RF Ack message isn’t received i.e. a peer Host Controller must be prepared to receive an “Acknowledged Data Indication” message multiple times.
Message Flow
Figure 0-1: Acknowledged Data Request
Command Message
Field Content Comment
DstID DATALINK_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x04 Acknowledged Data Request Length n, n > 2; n < 114 Variable Length Payload[0]
Payload[1] Payload [2…n-1] User Data User Data with n-2 octets
Device Address [Bits 0…7] Device Address [Bits 8…15]
Destination/Peer Device Address
Note: it makes no sense to send “acknowledged” messages as broadcast messages.
Response Message
The response message is sent to the local Host Controller if an acknowledgement from the peer WiMOD has been received. In this case the status “Command successful” is set in the Status Information Field (see Chapter 2.2). If no response has been received after the maximum
iM222A_UserManual, Wireless Solutions, V1.1 page 30 of 44
number of retransmission (including timeouts) have been sent, the status is set to “Command failed”.
Field Content Comment
DstID Sender ID Destination EP identifier, taken from preceding
Request command. SrcID DATALINK_ID Source EP identifier Opcode 0x05 Acknowledged Data Response Length 0 No payload
Event Message
This message is sent to a Host Controller as a result of a received “Acknowledged Data Request” message via RF link. The first two bytes in the payload field contain the source device address of the transmitting WiMOD.
Field Content Comment
DstID DATALINK_ID Destination EP identifier SrcID Sender ID Source EP identifier Opcode 0x06 Acknowledged Data Indication Length n, n > 2; n < 114 Variable Length Payload[0]
Payload[1] Payload[2…n-1] User Data User Data with n-2 octets
Device Address [Bits 0…7] Device Address [Bits 8…15]
Source Device Address
iM222A_UserManual, Wireless Solutions, V1.1 page 31 of 44
4 Global System Parameter
This chapter outlines several parameter and constants:
4.1 Global Module Identifier
The following table shows the global module type identifiers which are part of the Device Information Field:
WiMOD Module Type Value
iM222A 8
4.2 Global System Endpoint Identifier
The following table outlines the global system endpoint identifiers which are used to access dedicated software modules.
Endpoint Abbreviation Value Comment
Debug Handler DEBUG_ID 0xFF Endpoint for handling of debug
messages. Expected on host system
Device Management DEVMGMT_ID 0x90 Endpoint for Device Management
services
RF Data Exchange DATALINK_ID 0x91 Endpoint for RF Data Exchange services
iM222A_UserManual, Wireless Solutions, V1.1 page 32 of 44
5 Communication over UART
The WiMOD HCI Protocol uses a SLIP wrapping layer when transmitted over asynchronous serial interfaces (UART). The SLIP layer provides a mean to transmit and receive complete data packets over a serial interface. The SLIP coding is according to RFC 1055
[http://www.faqs.org/rfcs/rfc1055.html]
Figure 5-1:HCI Message Format over UART
Following the HCI message a 16-Bit frame check sequence is added to support a reliable packet transmission. The FCS contains a 16-Bit CRC-CCITT cyclic redundancy check which enables the receiver to check a packet for bit errors. The CRC computation starts from the Type Field and ends with the last Payload octet.
An example implementation for SLIP Coding and CRC calculation is given below.
5.1 Physical Parameters
The UART settings are:
115200 bps, 8 Databits, No Parity Bit , 1 Stop Bit
iM222A_UserManual, Wireless Solutions, V1.1 page 33 of 44
6 Hardware Integration Guide
6.1 Typical Application Schematic
Figure 6-1 shows a schematic of a typical application.
Figure 6-1: Sample application schematic using UART communication
In this sample application P0_2 and P0_3 are used as serial interface and should be connected to a host controller or to a host PC (via a level converter). P1_7, P0_1, P0_6, and P2_0 are used as outputs. It must be ensured that the maximum DC current per pin is not exceeded. P1_3 to P1_5 are used as digital inputs. A blocking capacitor is recommended between VCC and GND.
iM222A_UserManual, Wireless Solutions, V1.1 page 34 of 44
6.2 PCB Design Recommendation
~45 mm
111
12
~50 mm
23
3424
Figure 6-2: Recommended Environment
When designing a carrier board layout for the iM222A the following design considerations are recommended:
- The Top Layer of the carrier board should be kept free of tracks and vias under the iM222A
because there are some testpads on the bottom side of the module which are not covered by solder resist.
- As shown in Figure 6-2, the solid grey area must be a ground-plane on the Bottom Layer (or
Layer 2 in a multi-layer structure) of the carrier board. Antenna matching and all other measurements have been done with these dimensions.
Info: Other dimensions can affect the RF performance respective RF output power, sensitivity,
and unwanted emissions. Maybe the matching network of the integrated PCB antenna must be renewed.
- All radio module ground pads must be directly connected to the ground-plane by vias next to
each ground pad.
- The hatched area shown in Figure 6-2 has to be free of material (e.g. PCB, metal, housing). If
possible, the distance from the antenna area to any material should be at least /2
see 1
.
1
At 2.4 GHz it is approximately 62.5 mm.
iM222A_UserManual, Wireless Solutions, V1.1 page 35 of 44
6.3 Module Dimension
12
Microcontroller
Transceiver
23
8.00mm
111
&
Antenna
20.00mm ±0.2mm
3424
25.00mm ±0.2mm
Figure 6-3: Module Dimension
6.4 Recommended Footprint
The pad pitch is 1.27mm.
Figure 6-4: Footprint
All dimensions are in millimeters.
iM222A_UserManual, Wireless Solutions, V1.1 page 36 of 44
6.5 Recommended Soldering Conditions
An example of the temperature profile for the reflow soldering process of the iM222A is depicted in Figure 6-5 with the corresponding values as given by Table 6-1. The temperature values should not exceed the limits.
Figure 6-5: Recommended Solder Reflow Profile
Phase Pb-Free Conditions
t
= 120s
Preheating
Primary heat
Peak
PH
T
= 160~180°C
PH
= 60s
t
1
T
= 220°C
1
= 10s (max)
t
2
T
= 255°C
2
Table 6-1: Recommended Soldering Parameter for Temperature and Timing
Note: The quality of the soldering process depends on several parameters, e.g. soldering paste, carrier board design, fabrication equipment,...
iM222A_UserManual, Wireless Solutions, V1.1 page 37 of 44
7 Additional documentation
1. “iM222A_AN001_SW-Development”, IMST GmbH
This document gives an overview of the possible software options from Texas Instruments that can be used in conjunction with the iM222A and assists in finding the right documentation for a specific software solution. The pinout of the iM222A and the mapping to the CC2530 as well as the debugging interface and the WiMOD development board are described in detail within this document.
2. CC2530 datasheet (swrs081b.pdf), Texas Instruments
Datasheet of the CC2530, hardware information.
3. CC2530 User’s Guide (swru191b.pdf), Texas Instruments
This document describes the specific features, the peripherals and the register settings of the CC2530.
iM222A_UserManual, Wireless Solutions, V1.1 page 38 of 44
8 Packaging Information
8.1 Carrier Tape Information
All dimensions are in millimeters.
Figure 8-1: Dimensions of the iM222A Carrier Tape
8.2 Reel Information
Reel diameter Core diameter Core width Units per reel
330mm 100mm approx. 45mm max. 700
Table 2: Reel Information
iM222A_UserManual, Wireless Solutions, V1.1 page 39 of 44
9 Ordering Information
Ordering Part Number
iM222A Radio module iM222A wimod@imst.de SK – iM222A Coming soon wimod@imst.de AB – iM222A Coming soon wimod@imst.de
Notes:
Description Distributor
10 Appendix
10.1 List of Abbreviations
ADC Analog-to-Digital Converter
DIO Digital Input/Output
DLL Dynamic Link Library
FW Firmware
GPIO General Purpose Input/Output
HCI Host Controller Interface
HW Hardware
RF Radio Frequency
SPI Serial Peripheral Interface
SW Software
UART Universal Asynchronous Receiver/Transmitter
WiMOD Wireless Module
iM222A_UserManual, Wireless Solutions, V1.1 page 40 of 44
10.2 List of Figures
Figure 1-1: Host Controller Communication ........................................................................ 6
Figure 2-1: HCI Message Flow ........................................................................................... 7
Figure 2-2: WiMOD HCI Message ..................................................................................... 8
Figure 2-3: Type Field ....................................................................................................... 9
Figure 2-4: Control Field ................................................................................................. 10
Figure 3-1: Ping .............................................................................................................. 13
Figure 3-2: Reset Request ................................................................................................ 14
Figure 3-3: RF Ping ......................................................................................................... 24
Figure 3-4: Unreliable Data Request ................................................................................. 28
Figure 0-1: Acknowledged Data Request ........................................................................... 30
Figure 5-1:HCI Message Format over UART ...................................................................... 33
Figure 6-1: Sample application schematic using UART communication ................................ 34
Figure 6-2: Recommended Environment ............................................................................ 35
Figure 6-3: Module Dimension ......................................................................................... 36
Figure 6-4: Footprint ....................................................................................................... 36
Figure 6-5: Recommended Solder Reflow Profile ................................................................ 37
Figure 8-1: Dimensions of the iM222A Carrier Tape .......................................................... 39
10.3 References
IMST GmbH disclaims any responsibility for the contents of external links. The owner of the sites is responsible for its content. The validity of the referenced hyperlinks has been tested at publication date of this document. IMST GmbH cannot guarantee the long term validity of the hyperlinks.
iM222A_UserManual, Wireless Solutions, V1.1 page 41 of 44
11 Regulatory Compliance Information
R&TTE
The use of radio frequencies is limited by national regulations. The radio module has been designed to comply with the European Union’s R&TTE (Radio & Telecommunications Terminal Equipment) directive 1999/5/EC and can be used free of charge within the European Union.
Nevertheless, restrictions in terms of maximum allowed RF power or duty cycle may apply.
The radio module has been designed to be embedded into other products (referred as “final products”). According to the R&TTE directive, the declaration of compliance with essential requirements of the R&TTE directive is within the responsibility of the manufacturer of the final product. A declaration of conformity for the radio module is available from IMST GmbH on request.
FCC
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) this device my not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. (FCC Part
15.19).
Warning: Changes or modifications made to this equipment not expressly approved by IMST GmbH may void the FCC authorization to operate this equipment. (FCC Part 15.21)
If the label of the module wouldn’t be visible after integration in a device, the label of the device must include “contains FCC-ID Q9BWIMOD404530”
IC
This device complies with Industry Canada licence-exempt RSS standard(s). Operation is subject to the following two conditions: (1) this device may not cause interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device. (RSS-GEN)
If the label of the module wouldn’t be visible after integration in a device, the label of the device must include “contains IC 10740A-WIMOD404530”
Le présent appareil est conforme aux CNR d'Industrie Canada applicables aux appareils radio exempts de licence. L'exploitation est autorisée aux deux conditions suivantes : (1) l'appareil ne doit pas produire de brouillage, et (2) l'utilisateur de l'appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d'en compromettre le fonctionnement. (RSS-GEN).
Si l'étiquette du module ne serait pas visible après l'intégration dans un appareil, l'étiquette de l'appareil doit comporter "contient IC 10740A-WIMOD404530"
iM222A_UserManual, Wireless Solutions, V1.1 page 42 of 44
The applicable regulation requirements are subject to change. IMST GmbH does not take any responsibility for the correctness and accuracy of the aforementioned information. National laws and regulations, as well as their interpretation can vary with the country. In case of uncertainty, it is recommended to contact either IMST’s accredited Test Center or to consult the local authorities of the relevant countries.
iM222A_UserManual, Wireless Solutions, V1.1 page 43 of 44
12 Important Notice
12.1 Disclaimer
IMST GmbH points out that all information in this document is given on an “as is” basis. No guarantee, neither explicit nor implicit is given for the correctness at the time of publication. IMST GmbH reserves all rights to make corrections, modifications, enhancements, and other changes to its products and services at any time and to discontinue any product or service without prior notice. It is recommended for customers to refer to the latest relevant information before placing orders and to verify that such information is current and complete. All products are sold and delivered subject to “General Terms and Conditions” of IMST GmbH, supplied at the time of order acknowledgment.
IMST GmbH assumes no liability for the use of its products and does not grant any licenses for its patent rights or for any other of its intellectual property rights or third-party rights. It is the customer’s duty to bear responsibility for compliance of systems or units in which products from IMST GmbH are integrated with applicable legal regulations. Customers should provide adequate design and operating safeguards to minimize the risks associated with customer products and applications. The products are not approved for use in life supporting systems or other systems whose malfunction could result in personal injury to the user. Customers using the products within such applications do so at their own risk.
Any reproduction of information in datasheets of IMST GmbH is permissible only if reproduction is without alteration and is accompanied by all given associated warranties, conditions, limitations, and notices. Any resale of IMST GmbH products or services with statements different from or beyond the parameters stated by IMST GmbH for that product/solution or service is not allowed and voids all express and any implied warranties. The limitations on liability in favor of IMST GmbH shall also affect its employees, executive personnel and bodies in the same way. IMST GmbH is not responsible or liable for any such wrong statements.
Copyright © 2012, IMST GmbH
12.2 Contact Information
IMST GmbH
Carl-Friedrich-Gauss-Str. 2 47475 Kamp-Lintfort Germany
T +49 2842 981 0 E wimod@imst.de F +49 2842 981 299 I www.wireless-solutions.de
iM222A_UserManual, Wireless Solutions, V1.1 page 44 of 44
Loading...
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use