How it Works
OCEASOFT
Loading...
C
M
P
Loading...
Loading...
MOD
Users Manual
74 pgs1.28 Mb0
Table of contents
Loading...

OCEASOFT MOD Users Manual

Document : XTLMOD -UserMan.sxw
XLTMOD
User Manual
XLTMOD Handbook page 1 of 74
Document : XTLMOD -UserMan.sxw
REVISIONS HISTORY
Rev. # Description Auteur Date Commentaires
1 Original document PGN 19/09/08 Version 1
➢ FIRMWARE VERSIONS OF SUPPORTED XLTMOD
This device complies with part 15 of the FCC rules. Operation is subject to the following two conditions : this device may not cause harmful interference, and this device must accept any interference received, including interference that may cause undesired operation.
Caution : any changes or modifications not expressly approved by Coronis­Systems could void the user's authority to operate the equipment.
XLTMOD Handbook page 2 of 74
Document : XTLMOD -UserMan.sxw
TABLE OF CONTENTS
1. INTRODUCTION..........................................................................................................................................5
2. RS232 SERIAL PROTOCOL PRESENTATION............................................................................................6
2.1- Exchanges principle...........................................................................................................................6
2.1.1 - Low level acknowledge................................................................................................................6
2.1.2 - Request/ Response principle.......................................................................................................7
2.2- Exchanged frames format.................................................................................................................8
2.2.1 - Wake Up and synchronization mechanism..................................................................................8
2.2.2 - Frame description........................................................................................................................8
2.3- Commands description....................................................................................................................10
2.3.1 - Control type commands.............................................................................................................10
2.3.2 - Applicative type commands.......................................................................................................10
2.3.3 - Service type commands.............................................................................................................12
3. SETTING THE INTERNAL PARAMETERS OF THE WAVECARD............................................................13
3.1- Configuration of the functional parameters...................................................................................13
3.1.1 - Format of the internal parameters access.................................................................................14
3.1.2 - Wake Up and synchronization mechanism................................................................................17
a) Principle when transmitting, or receiving a frame.........................................................................................17
b) Example describing a point-to-point exchange of the type Request / Response.........................................19
3.2- Configuration of the control parameters........................................................................................20
3.2.1 - selection of the radio operating channel when FHSS is deselected...........................................20
a) reading commands format of the channel used............................................................................................20
b) Writing commands format of the channel to use...........................................................................................21
3.2.2 - Selection of the RF medium physical mode..............................................................................22
a) reading commands format of the physical layer mode..................................................................................22
b) selection commands format of the physical layer mode to use....................................................................23
c) Automatic selection of Radio physical mode to use......................................................................................23
3.2.3 - Selection of the radio board emission power.............................................................................24
a) selection commands format of the emission power......................................................................................24
b) reading commands format of the emission power........................................................................................25
3.2.4 - Activation of the Wavenis RF Asic RSSI threshold autocorrection.............................................26
a) Modification commands format of the RSSI threshold autocorrection state ................................................26
b) Reading commands format of the RSSI threshold autocorrection state ......................................................27
3.2.5 - Selection de la vitesse de transmission série.............................................................................28
a) Selection commands format of the baudrate................................................................................................28
3.2.6 - Reading the firmware version of the WaveCard.........................................................................29
a) Commands format.........................................................................................................................................29
3.2.7 - Reading the RSSI level (Received Signal Strengh Indicator)...................................................30
a) Commands....................................................................................................................................................30
b) Format of the commands...............................................................................................................................31
3.2.8 - TEST Mode................................................................................................................................32
a) Command......................................................................................................................................................32
b) Format of the command................................................................................................................................32
4. SERVICE COMMANDS..............................................................................................................................33
4.1- Description of the commands, and their formats..........................................................................33
XLTMOD Handbook page 3 of 74
Document : XTLMOD -UserMan.sxw
4.2- Request types...................................................................................................................................34
4.3- Presence detection principle between WAVECARD......................................................................35
5. COMMUNICATION MODES.......................................................................................................................36
5.1- 'Frame Exchange’ Mode...................................................................................................................36
5.1.1 - Configuration of the parameters relating to the 'Frame Exchange' mode..................................36
5.1.2 - Description of the commands, and their formats........................................................................37
5.1.3 - Use of the Relaying mode..........................................................................................................38
a) On frame transmission..................................................................................................................................38
b) On frame reception........................................................................................................................................38
5.1.4 - Time-out management...............................................................................................................41
5.2- 'Message’ Mode................................................................................................................................43
5.2.1 - Configuration of the parameters relating to the 'Message' mode...............................................43
5.2.2 - Description of the commands, and their formats........................................................................43
5.2.3 - Use of the Relaying mode..........................................................................................................45
a) On frame transmission..................................................................................................................................45
b) On frame reception........................................................................................................................................45
c) Diagram of the relaying mode.......................................................................................................................46
5.3- ’Polling’ Mode..................................................................................................................................49
5.3.1 - Configuration of the parameters relating to the 'Polling' mode...................................................49
5.3.2 - Description of the commands, and their formats........................................................................50
5.3.3 - Difference between selective, and not-selective Polling mode...................................................51
5.3.4 - Diagram of an exchange in polling mode...................................................................................54
5.4- ’Broadcast’ mode............................................................................................................................56
5.4.1 - Configuration of the parameters relating to the 'Broadcast' mode..............................................56
5.4.2 - 'BroadCast' mode without waiting for a response......................................................................56
a) Description of the commands........................................................................................................................56
b) Example of operations during a broadcast exchange, without waiting for responses..................................57
5.4.3 - 'BroadCast' mode with waiting for responses.............................................................................57
a) Description of the commands........................................................................................................................57
b) Example of operations during a broadcast exchange, with waiting for responses.......................................58
5.4.4 - Format of the commands – from the request transmitter side...................................................59
5.4.5 - Format of the commands – from the request receiver side........................................................60
5.4.6 - Use of the selective, or not-selective broadcast mode...............................................................60
5.5- ’Multi frames' Mode..........................................................................................................................61
5.5.1 - Principle.....................................................................................................................................61
5.5.2 - Format of the received frames...................................................................................................61
APPENDIX 1 : Mechanical description of the WAVECARD........................................................................62
APPENDIX 2 : Electric interface of the WAVECARD...................................................................................64
APPENDIX 3 : List of the functional parameters........................................................................................65
APPENDIX 4 : List of the commands of parameters setting.....................................................................66
APPENDICE 5 : List of the commands of data transmission....................................................................67
XLTMOD Handbook page 4 of 74
Document : XTLMOD -UserMan.sxw

1. INTRODUCTION

The XLTMOD is based on a Wavecard 25 mW.
The WAVECARD equipment acts like a RS232 Radio frequency gateway.
This device is driven through a USART link (RS232 or TTL) by a client application (called HOST in the continuation of this document) embedded on a microcontroller or on a PC equipment.
The main features of the WAVECARD are :
to send a frame on the RF medium depending on Host equipment
to inform Host equipment about received frame
Exchanges between two WAVECARD require that each one is connected to a Host device.
However, Wavecard can process some specific frames without Host connected. These exchanges are called Service Exchanges and are mainly used for installation and maintenance procedures.(cf. §4).
The purpose of this document is to present:
the low level of the exchange protocol to drive the Wavecard radio board through an
asynchronous serial RS232 interface (±12V) or compliant with TTL level (0-3V) ;
the electrical interface of the Wavecard radio board ;
the mechanical interface of the Wavecard radio board ;
This document serves as a specification to drive a DLL driving library on PC environment in the case the Wavecard radio board is used as a RF Modem either to be integrated in a existing electronic device or to be driven by a specific CPU mother board.
This document is also useful for the Waveport equipment. Waveport is a PC connected oriented RF modem based on the Wavecard.
In this document the Host term is used to speak about the equipment or sub-equipment that is driving the Wavecard radio board. The radio board term indicates the Wavecard equipment .
XLTMOD Handbook page 5 of 74
Document : XTLMOD -UserMan.sxw

2. RS232 SERIAL PROTOCOL PRESENTATION

This protocol is dedicated to an asynchronous RS232 or TTL link between the host and the radio board.
➢ Transmission format :
8 bits data, 1 stop bit, no parity
➢ Transmission speed : 9600 baud (contact us for other speed : marketing@coronis-systems.com)

2.1- Exchanges principle

The host or the radio board can take the initiative of the exchange. Nevertheless in the high majority of the cases, the host will take the initiative.
Fig. 1 – synoptic of the exchanges between a WavePort modem, and its host

2.1.1 - Low level acknowledge

In all the cases, the serial frames exchanged between the host and the radio board are managed by an acknowledge mechanism.
A minimum latency time of 1 ms must be respected between the frame reception and the corresponding acknowledge emission in order to respect the radio board processing time after a frame reception.
If the Acknowledge frame is not received by the initiator, it can decide to re-send several times the frame (retries mechanism). The RF default setting is :
Time-out = 500 ms
repetition number = 3
XLTMOD Handbook page 6 of 74
Document : XTLMOD -UserMan.sxw

2.1.2 - Request/ Response principle

Some exchanges need a Request/response mechanism.
In this case , an high level acknowledge (RES prefix command) is initiated by the RF board following the request frame (REQ prefix command) sent by the host.
The request frame are identified by REQ_XXX_XXX
example : REQ_SEND_FRAME
The high level acknowledge frame are identified by RES_XXX_XXX
example : RES_SEND_FRAME
In this example, from the request transmitter side, the frame RECEIVED_FRAME is the response associated to the request REQ_SEND_FRAME.
The high level acknowledgement of the request is identified by the RES_SEND_FRAME frame.
XLTMOD Handbook page 7 of 74
Document : XTLMOD -UserMan.sxw

2.2- Exchanged frames format

2.2.1 - Wake Up and synchronization mechanism

In the purpose to optimize power consumption, the Wavecard is in a STANDBY mode and is wakening up either :
periodically to poll a radio activity ;on a serial frame reception coming from the host equipment.
A synchronization character is needed before the data in the serial frame to give time to the radio board to wake up. This character is in hexadecimal notation : 0xFF.
To be homogeneous, the radio board precedes as well its frames emissions with this synchronization character.

2.2.2 - Frame description

The frames format is standardized as following :
SYNC STX LENGTH CMD DATA CRC ETX
1 byte 1 byte 1 byte 1 byte De 0 à 250 bytes 2 bytes 1 byte
Synchro.
character
0xFF 0x02 0x03
Start of
transmission
character
Note : - The frame minimum size is 6 bytes.
- The frame maximum size is 256 bytes.
The frame length (byte LENGTH) is computed from its own position until the included CRC. Bytes SYNC, STX and ETX are not included in the length.
Frame
length
Command Data
LENGTH
Control
Redundancy
Check
LSB First
End of
transmission
character
To insure transmitted information integrity between the host and the radio board, a CRC code on 16 bits is computed on overall frame data excepted STX and ETX characters ( the byte LENGTH is inserted in the CRC).
The CRC code is computed by a division of the frame binary sequence by the following polynomial:
X16 + X12 + X5 + 1
A coding example is indicated on the next page.
XLTMOD Handbook page 8 of 74
Document : XTLMOD -UserMan.sxw
CRC principle coding in C language :
#include <iostream.h> #include <stdio.h> #include <string.h>
void main ( )
{
int Poly = 0x8408; int lg = 9; unsigned int Frame [] = { 0x0B, 0x20, 0x43, 0x06, 0x01, 0x00, 0x00, 0x02, 0X01}; unsigned int Crc; int j, i_bits, carry;
Crc = 0;
for ( j=0 ; j < lg ; j++ )
{ Crc = Crc ^ Frame[j] ;
for ( i_bits=0 ; i_bits < 8 ; i_bits++ )
{ carry = Crc & 1 ; Crc = Crc / 2 ;
if ( carry )
{ Crc = Crc ^ Poly; }
}
}
printf ( “CRC = %x “, Crc);
}
The computed CRC is the following : 41D2 hexadecimal Then LSB byte and MSB byte must be inverted before storage in the frame.
This example allows to compute a CRC on a fix frame length equal to 9.
XLTMOD Handbook page 9 of 74
Document : XTLMOD -UserMan.sxw

2.3- Commands description

All the frames circulating on the serial bus are formatted as described in chapter 2.2.2. The distinction between the various frames is carried out via the 'CMD' fields representing the command (or the action) to carry out.
The available commands types can be classified in three parts :
Control type commandsApplicative commandsService type commands

2.3.1 - Control type commands

This commands are used for the low level acknowledgement of the serial frames.
CMD NAME DESCRIPTION DATA FIELD FORMAT
0x06 ACK
0x15 NAK
0x00 ERROR
Acknowledge Frame : Sent by the receiver after reception of a Request /Response frame type supported and understood.
Non Acknowledge Frame : Sent by the receiver after reception of a Request /Response frame not understood.
Error frame : Sent by the receiver after reception of a Request/response frame understood but not supported.
No data field.
No data field.
Byte 1 : 0x01 : unknown command.

2.3.2 - Applicative type commands

The applicative type commands use the Request/response mechanism.
We distinguish two parts in the applicative type commands : the commands relating to the parameter setting and the configuration of the board ; and in addition the commands relating to radio exchanges.
➢ Commands relating to the parameter setting
Read, or update the internal parameters, Read, or select the radio operating channel when FHSS is deselected, Read, or select the RF medium physical mode, Read, or select the radio board emission power, Activation of the Wavenis RF Asic RSSI threshold autocorrection, Modification of the serial link baudrate, Reading the RSSI level of a distant equipment, Reading the RSSI level of the wavecard, following an exchange with a distant equipment, Reading the firmware version of the WaveCard, Set the WaveCard into a test mode.
XLTMOD Handbook page 10 of 74
Document : XTLMOD -UserMan.sxw
➢ Commands relating to radio exchanges
The radio exchanges are composed of several modes of transmission/reception. With in certain cases, the possibility of receiving several consecutive radio frames (multi frames mode, accessible in reception only).
The following modes allow point-to-point exchanges :
’Frame Exchange’ mode : This mode allows to emit a request, with waiting of a radio response
from the distant equipment.
Following the radio frame sending, the Wavecard radio board stay in radio reception during a time (fixed by default at 2s, cf. RADIO_USER_TIMEOUT) in order to receive the response from the addressed equipment. During this time the serial RS232 link is not managed. This command is particularly intended to read CORONIS SYSTEMS radio modules used to collect remote information (temperature, humidity, meters index, ...).
‘Message’ mode : allows to emit a request, without waiting of a radio response from the distant
equipment.
After radio frame emission, the Wavecard radio board is listening again the serial RS232 link. This command is suited to a simple data transfer between several Wavecard equipments.
Moreover exchanges of the point-to-point types have an additional mode which allow to reach a module out of radio range of the transmitter, by relaying the frames via other equipments.
'Relaying' mode : this functionality allow to use a radio equipment to repeat a frame which is not
initially intended to him.
This functionality is used when the transmitter equipment, and the recipient of the request are out of radio range. The maximum number of repeaters is limited to 3.
The remaining modes allow exchanges with several distant equipments, in a selective way or not.
‘Polling’ mode : allows to address a request to a list of known distant equipment. The response
is sent to the host, transmitter of the request, when all the distant equipment responded, or on time­out.
In this case, the list of the distant equipments is configured via a command of parameter setting (see chapter 3)
’Broadcast’ mode : allows to address a request to all the distant equipment within radio range
of the transmitter, or only to a group of equipment in radio range of the transmitter.
Particular Case: multi-frames reception
Multi frame mode allows multi frame exchange between the Wavecard/Waveport (considered like the master of the exchange) and one of the telemetry equipments of the Coronis Systems product family ( WaveTherm, WaveFlow, WaveSens, ...). Current version of Wavecard does not allow multi frame mode between two Wavecard/Waveport equipments.
XLTMOD Handbook page 11 of 74
Document : XTLMOD -UserMan.sxw

2.3.3 - Service type commands

Services commands are used to configure the Wavecard or to read radio parameters independently of the connected host equipment.
When the wavecard recognizes Service command, no data are sent to the connected host.
These commands are mainly used to:
Process detection of a distant RF equipmentProcess a link budget with a distant equipment (RSSI level detection)Process the setting of parameters by RF way
the details of the frame format, and its usage is described in chapter 4.
XLTMOD Handbook page 12 of 74
Document : XTLMOD -UserMan.sxw

3. SETTING THE INTERNAL PARAMETERS OF THE WAVECARD

The internal parameters of WaveCard are declined in two categories :
parameters of control (emission power level, channel selection, etc...) carried out by specific
frame of type Request/Response. this parameters allows to modify the mode of communication (either serial, and RF).
Functional parameters (WakeUp period, group number, etc...) carried out by the same frame of
writing of internal parameters. this parameters allows to modify the behavior of WaveCard, according to the type of radio exchange used.
Attention, the setting parameter commands apply only to a local WaveCard, not to a distant one.

3.1- Configuration of the functional parameters

The functional parameters are directly related to the default operation of WaveCard, and to the types of radio exchanges used. I.e. according to the type of radio exchange which will be used, the functional parameters will have to be initialized.
Default values are set at the first initialization of the product.
Paramet er number
0x00
0x01
0x02
0x03
0x04
0x05 RADIO_ADDRESS : radio board address
0x06
Description Value Size
AWAKENING_PERIOD : polling period of RF
medium radio, in multiples of 100ms
WAKEUP_TYPE : Wake Up type used during a frame emission
WAKEUP_LENGTH : duration of the Wake up when long wake up is set up.
This value must be higher than the polling period of RF medium radio.
Value in multiples of 1ms, defined LSB first
WAVECARD_POLLING_GROUP : Byte containing the Polling Group of the Wavecard.
RADIO_ACKNOWLEDGE : indicates if the radio frames must be acknowledged by the receiver.
RELAY_ROUTE_STATUS : Parameter relative to Relay route transmission in each relayed frame received
Period in multiples of 100ms
(by default, 0x0A for one second)
0 = quasi-permanent reception (every 20ms)
0 : long Wake Up (default setting)
1 : short Wake Up = 50 ms
Default value : 1100 ms
min value = 20 ms (0x1400)
max value = 10 sec. (0x1027)
Byte 1 : Polling_Group
by default, Polling_Group = 0x00
0 : no acknowledge (default value)
1 : acknowledge used
This Value is issue from the manufacturing. In Reading only
0x00 : Relay route transmisson deactivated
0x01 : Relay route transmission activated
by default, Relay route transmisson deactivated
(in byte)
1
1
2
1
1
6
1
XLTMOD Handbook page 13 of 74
0x07
0x08
0x09
0x0A
0x0C
0x0E
0x10
0x16
0x17
RELAY_ROUTE : Table containing the radio addresses for successive repeaters to use to reach the final equipment.
POLLING_ROUTE : Table containing the list of
modules radio address to be addressed.
GROUP_NUMBER : Byte containing the number of the group of radio equipment to address in radio polling mode.
POLLING_TIME : delay between two consecutive emission in polling mode
RADIO_USER_TIMEOUT : time-out used for the reception of a response frame
EXCHANGE_STATUS : parameter relative to the error or status frame management activation.
SWITCH_MODE_STATUS : automatic selection of Radio physical mode used to address an equipment depending on radio address
WAVECARD_MULTICAST_GROUP : Byte containing the Multicast Group of the Wavecard (available from V2.00 version ).
BCST_RECEPTION_TIMEOUT : timeout used for the reception of CSMA frame consecutively to REQ_SEND_BROADCAST Command emission (available from firmware V2.01 version )
Document : XTLMOD -UserMan.sxw
BYTE 1 : number of repeaters in the route
Maximum repeater number = 3
Si BYTE 1 != 0
BYTES 2 à 7 : First repeater radio
address
…, and so on.
BYTE 2 : number of equipments to interrogate
IF BYTE 2 != 0 BYTES 3 to 8 : radio address of the first
module..., and so on.
Group number by default, GROUP_NUMBER = 0x00
Value in multiples of 100ms By default, POLLING_TIME = 0x0A
Value in multiples of 100ms default value = 0x14 (2 seconds)
0 : status and error frame deactivated, 1 : error frame activated, 2 : status frame activated, 3 : both status and error frames
activated, by default, RECEPT_ERROR_STATUS =
0x00.
0 : automatic selection deactivated 1 : automatic selection activated Default value, SWITCH_MODE_STATUS =
0x00
By default, no group selected = 0xFF 1
Valeur in multiples of100ms. Default = 0x3C (6 seconds)
1 à 19
1 à
241
1
1
1
1
1
1

3.1.1 - Format of the internal parameters access

The Wavecard equipment manage internal parameters mainly relative to RF features. RS232 commands allow to access these parameters in read or write mode. Default values are set at the first initialization of the product.
REQ_READ_RADIO_PARAM command is used to read parameters and REQ_WRITE_RADIO_PARAM is used to write parameters. Each parameter must be accessed individually.
XLTMOD Handbook page 14 of 74
Document : XTLMOD -UserMan.sxw
CMD NOM DESCRIPTION
0x40 REQ_WRITE_RADIO_PARAM Request to update the radio parameters
0x41 RES_WRITE_RADIO_PARAM
0x50 REQ_READ_RADIO_PARAM Request to read the radio parameters.
0x51 RES_READ_RADIO_PARAM Response from the radio board to a parameters reading.
Response from the radio board to the radio parameters update
Remark : In the command byte coding, the Response frame type are taking the Request command byte value with the LSB bit set to 1.
Data field formats to read or to update the radio parameters is the following :
Request to read the radio parameters
REQ_READ_RADIO_PARAM
HEADER CMD DATA CRC ETX
3 bytes 1 byte 1 byte 2 bytes 1 byte
0xFF ; 0x02 ;
0x05
0x50 Number of the parameter to read 0x03
Response from the radio board to a parameters reading
RES_READ_RADIO_PARAM
HEADER CMD DATA CRC ETX
3 bytes 1 byte 1 byte 1 byte variable 2 bytes 1 byte
0xFF ; 0x02 ;
0xXX
0x51
Status = 0x00 read ok
Status = 0x01 read error
Parameter number value
-
Request to update the radio parameters
REQ_WRITE_RADIO_PARAM
HEADER CMD DATA CRC ETX
3 bytes 1 byte 1 byte variable 2 bytes 1 byte
0xFF ; 0x02 ;
0xXX
0x40
Number of the parameter to
update
Parameter data 0x03
0x03
Response from the radio board to the radio parameters update
XLTMOD Handbook page 15 of 74
Document : XTLMOD -UserMan.sxw
RES_WRITE_RADIO_PARAM
HEADER CMD DATA CRC ETX
3 bytes 1 byte 1 byte 2 bytes 1 byte
0xFF ; 0x02 ;
0x05
0x41
= 0x00 update OK
= 0x01 update error
Timeout management : The WaveCard can be considered in fault, beyond the value of the following latencies:
REQ_WRITE_RADIO_PARAM 2 seconds. REQ_READ_RADIO_PARAM 2 seconds.
EXAMPLE : configuration of the repeaters table, and activation of error frames.
Between WaveCard (exchange instigator), and the recipient equipment, we have a repeater equipment(radio address : 0X AA AA AA AA AA AA). In addition, we must authorize the error frame, in order to determine which distant equipment caused the error.
STATUS
•
Writing new parameters
repeaters list configuration (Request/Response mechanism)
Request from the host to the WaveCard (
REQ_WRITE_RADIO_PARAM)
0x03
HEADER
SYN
C
0xFF
LENGT
STX
0x0
0x0C 0x40 0x07 0x01 ; 0xAAAAAAAAAAAA 0xXXXX 0x03
2
CMD
Parameter
H
number
Response from the WaveCard to the host (
HEADER
SYNC STX LENGT
CMD
RES_WRITE_RADIO_PARAM)
Status of the update
DATA
Parameter data
DATA
CRC ETX
CRC ETX
H
0xFF 0x02 0x05 0x41 0x00 0xXXXX 0x03
Activation of the error frames (Request/Response mechanism)
Request from the host to the WaveCard (REQ_WRITE_RADIO_PARAM)
SYN
C
HEADER
STX
LENGT
H
CMD
Parameter
number
DATA
CRC ETX
Parameter data
XLTMOD Handbook page 16 of 74
Document : XTLMOD -UserMan.sxw
0xFF 0x02 0x06 0x40 0x0E 0x01 0xXXXX 0x03
Response from the WaveCard to the host (RES_WRITE_RADIO_PARAM)
HEADER
SYNC STX LENGT
0xFF 0x02 0x05 0x41 0x00 0xXXXX 0x03
CMD
H
Status of the update
DATA
CRC ETX

3.1.2 - Wake Up and synchronization mechanism

In the purpose to optimize power consumption, the Wavecard is in a STANDBY mode and is wakening up periodically to poll a radio activity. The wakeup period is given by the value of the AWAKENING_PERIOD parameter, expressed in multiples of 100ms (1 second by default).
a) Principle when transmitting, or receiving a frame
When transmitting a frame to a distant equipment, the transmitter begins an awakening preamble called 'WakeUp' being used to awake the receiving equipments which will position then in radio reception. This preamble results in the sending on the radio medium, of a binary succession of symbol.
This awakening preamble (WakeUp) can be of two types,
Long WakeUp : used when transmitting a request towards distant equipment. Its duration can be
parameterized by the user (1100ms by default); and is generally equal to the WakeUp period of the equipment to address, plus 100ms, in order to avoid transmitting between two periods of reception.
Short WakeUp : used only when responding to a point-to-point request. Its duration is equal to
50ms, and cannot be configured.
NUM DESCRIPTION VALUE
Period in multiples of 100ms
0x00
0x01
AWAKENING_PERIOD : polling period of RF medium radio, in multiples of 100ms
WAKEUP_TYPE : Wake Up type used during a frame emission
(by default, 0x0A for one second)
0 = quasi-permanent reception (every 20ms)
0 : long Wake Up (default setting)
1 : short Wake Up = 50 ms
SIZE (in bytes)
1
1
XLTMOD Handbook page 17 of 74
Document : XTLMOD -UserMan.sxw
WAKEUP_LENGTH : duration of the Wake up when
0x02
long wake up is set up.
This value must be higher than the polling period of RF medium radio.
Value in multiples of 1ms, defined LSB first
Default value : 1100 ms
min value = 20 ms (0x1400)
max value = 10 sec. (0x1027)
The receiver of the exchange, when it detect WakeUp preamble on the radio medium, carries out the following operations:
It starts a timeout of waiting for the synchronization word (sync), which the duration is slightly
higher than its WakeUp period. This duration cannot be configured.
It begins a validation phase of the WakeUp preamble (detection of WakeUp). This phase
corresponds to the detection of several successive symbols composing the preamble. If the detection fails, the equipment is repositioned in stand-by mode. The time of detection depends on the speed transmission used.
The periodic wakeup having to occur when waiting of synchronization, are memorized (in order to preserve the periodicity), but not carried out.
2
At the end of the phase of WakeUp, the transmitter equipment send a sequence of synchronization, followed by data to be transmitted.
➢ Typical case (Long WakeUp = receiver WakeUp period + 100ms)
➢ Case of too short WakeUp (lower than the receiver WakeUp period)
XLTMOD Handbook page 18 of 74
Document : XTLMOD -UserMan.sxw
➢ Case of too long WakeUp (much higher than the receiver WakeUp period)
b) Example describing a point-to-point exchange of the type Request / Response.
When using a point-to-point exchange of the type request/ Response, the transmission of the request is made in the same way that previously. But the transmitter, after the sending of the data, awaits for a response, during a time which can be configured by the RADIO_USER_TIMEOUT parameter (0x0C).
The receiver, after treatment of the request, will return its response by using a specific WakeUp preamble, called short WakeUp (Long WakeUp being useless since the transmitter is already in phase of reception).
➢ Exchange without radio acknowledge
XLTMOD Handbook page 19 of 74
➢ Exchange with radio acknowledge
Document : XTLMOD -UserMan.sxw
Configuration example of the parameters of wakeup management.
during an exchange between two WaveCard, where between two idle periods the transmitter must quickly transmit data to the receiver.
1- Send a command of parameter modification to the receiver of the exchange, to modify its WakeUp period to 0 (quasi-permanent reception) ;
2- Configure WakeUp_Length parameter of the transmitter with 40ms ; 3- transmit the data to the receiver ; 4- To send a command of parameter modification to the receiver of the exchange, to modify its
wakeup period to 10s (default value). 5- Configure WakeUp_Length parameter of the transmitter with 1100ms (default value).

3.2- Configuration of the control parameters

The parameters of control allow on the one hand, to modify the mode of radio communication, and serial communication; and furthermore, fetch information on the local module, and the quality of the communication with a distant module.

3.2.1 - selection of the radio operating channel when FHSS is deselected

It is possible to modify the transmission channel Reception via requests of reading, and writing. The
XLTMOD Handbook page 20 of 74
commands are as follows,
CMD NOM DESCRIPTION
0x60 REQ_SELECT_CHANNEL
0x61 RES_SELECT_CHANNEL
0x62 REQ_READ_CHANNEL
0x63 RES_READ_CHANNEL
Remark : These commands are used only when the mode of radio communication is mono-frequency with selection of channel.
a) reading commands format of the channel used
Request, from the host to the WaveCard
REQ_READ_CHANNEL
HEADER CMD CRC ETX
3 bytes 1 byte 2 bytes 1 byte
0xFF ; 0x02 ;
0x04
0x62 0x03
Document : XTLMOD -UserMan.sxw
Request to select the radio operating channel when FHSS is deselected
Response to the channel selection request
Request to read the radio operating channel when FHSS is deselected
Response to the read channel request
Response, from the WaveCard to the host
RES_READ_CHANNEL
HEADER CMD DATA CRC ETX
3 bytes 1 byte variable 2 bytes 1 byte
0xFF ; 0x02 ;
0xXX
Status = 0x00
reading ok
0x63
Status = 0x01
reading error
Channel number
1 byte
-
b) Writing commands format of the channel to use
Request, from the host to the WaveCard
REQ_SELECT_CHANNEL
HEADER CMD DATA CRC ETX
0x03
XLTMOD Handbook page 21 of 74
Document : XTLMOD -UserMan.sxw
3 bytes 1 byte 1 byte 2 bytes 1 byte
0xFF ; 0x02 ;
0x05
Response, from the WaveCard to the host
HEADER CMD DATA CRC ETX
3 bytes 1 byte 1 byte 2 bytes 1 byte
0xFF ; 0x02 ;
0x05
0x60 Channel number (de 0 à 21) 0x03
RES_SELECT_CHANNEL
0x61
( 0x00 : update OK ; 0x01 : update error )
Status
0x03

3.2.2 - Selection of the RF medium physical mode

The available physical layer modes, are :
• 868 MHz single channel 4800 baud,
• 868 MHz single channel 4800 bauds Alarm Band,
• 868MHz single channel 9600 bauds with channel selection,
• 868 MHz frequency hopping 9600 baud,
XLTMOD Handbook page 22 of 74
Document : XTLMOD -UserMan.sxw
• 868 MHz frequency hopping 19200 baud,
• 869MHz 500mW Band (for Wavecard 25mW radio board, this mode is supported but the
emission power is limited).
It is possible to modify the physical layer mode via requests of reading, and writing. The commands are as follow,
CMD NAME DESCRIPTION
0x64 REQ_SELECT_PHYCONFIG Request to select the RF medium physical mode
0x65 RES_SELECT_PHYCONFIG Response to the physical mode selection request
0x66 REQ_READ_PHYCONFIG Request to read the RF medium physical mode
0x67 RES_READ_PHYCONFIG Response to the physical mode reading request
Remark : In the command byte coding, the Response frame type are taking the Request command byte value with the LSB bit set to 1.
a) reading commands format of the physical layer mode
Request, from the host to the WaveCard
REQ_READ_PHYCONFIG
HEADER CMD CRC ETX
3 bytes 1 byte 2 bytes 1 byte
0xFF ; 0x02 ;
0x04
Response, from the WaveCard to the host
HEADER CMD DATA CRC ETX
3 bytes 1 byte variable 2 bytes 1 byte
0xFF ; 0x02 ;
0xXX
0x66 0x03
RES_READ_PHYCONFIG
Status = 0x00
reading ok
0x67
Status = 0x01
reading error
Transmission mode
2 bytes
-
0x03
Remark : the following table describes the available physical layer modes
Value
868 MHz single channel 4800 baud 0x0012
XLTMOD Handbook page 23 of 74
Loading...
+ 51 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use