Do you have a question about the WaveCard 25mW and is the answer not in the manual?
Questions and answers
Summary of Contents for Coronis WaveCard 25mW
Page 1
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw WaveCard user handbook page 1 of 67...
Page 2
: 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. WaveCard user handbook...
Document : CS-SUP-MUTI-WPORTAPP-E02.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...
Page 4
Document : CS-SUP-MUTI-WPORTAPP-E02.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..........................
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 1. INTRODUCTION 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 ...
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.
Document : CS-SUP-MUTI-WPORTAPP-E02.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...
Document : CS-SUP-MUTI-WPORTAPP-E02.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 ; ...
Page 9
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw CRC principle coding in C language : #include <iostream.h> #include <stdio.h> #include <string.h> void main ( ) Poly = 0x8408; lg = 9; unsigned int Frame [] = { 0x0B, 0x20, 0x43, 0x06, 0x01, 0x00, 0x00, 0x02, 0X01}; unsigned int Crc;...
Document : CS-SUP-MUTI-WPORTAPP-E02.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.
Page 11
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.
Document : CS-SUP-MUTI-WPORTAPP-E02.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: ...
Document : CS-SUP-MUTI-WPORTAPP-E02.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).
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw BYTE 2 : number of equipments to interrogate POLLING_ROUTE : Table containing the list of modules IF BYTE 2 != 0 0x08 1 à 241 radio address to be addressed. BYTES 3 to 8 : radio address of the first module..., and so on.
Page 15
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 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 DATA 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF ; 0x02 ; 0x05 0x50 Number of the parameter to read 0x03...
Page 16
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 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.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 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).
Page 18
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw Typical case (Long WakeUp = receiver WakeUp period + 100ms) ➢ ➢ Case of too short WakeUp (lower than the receiver WakeUp period) ➢ Case of too long WakeUp (much higher than the receiver WakeUp period) WaveCard user handbook page 18 of 67...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 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).
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 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.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw b) Writing commands format of the channel to use Request, from the host to the WaveCard REQ_SELECT_CHANNEL HEADER DATA 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF ; 0x02 ; 0x05 0x60 Channel number (de 0 à 21) 0x03 ...
868 MHz frequency hopping 9600 baud, • 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...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw Remark : the following table describes the available physical layer modes Value 868 MHz single channel 4800 baud 0x0012 868 MHz single channel 4800 bauds Alarm Band 0x0094 868MHz single channel 9600 bauds with channel selection 0x00A2 868 MHz frequency hopping 9600 baud 0x00A3 868 MHz frequency hopping 19200 baud...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 3.2.3 - Selection of the radio board emission power Compatibility: This functionality is accessible only on WaveCard 25mW. It is possible to adjust the radio board emission power of WaveCard, according to the following table (by default, the level is configured to 14dBm):...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw b) reading commands format of the emission power Request, from the host to the WaveCard REQ_READ_TX_POWER HEADER 3 bytes 1 byte 2 bytes 1 byte 0xFF ; 0x02 ; 0x04 0x54 0x03 Response, from the WaveCard to the host RES_READ_TX_POWER HEADER DATA...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 3.2.4 - Activation of the Wavenis RF Asic RSSI threshold autocorrection The RSSI threshold autocorrection is a functionality which allows WaveCard to adjust its threshold of reception, according to the ambient noise in a preoccupation with an energy saving. This functionality is adapted if WaveCard is fed by battery.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw b) Reading commands format of the RSSI threshold autocorrection state Request, from the host to the WaveCard REQ_READ_AUTOCORR_STATE HEADER 3 bytes 1 byte 2 bytes 1 byte 0xFF ; 0x02 ; 0x04 0x5A 0x03 Response, from the WaveCard to the host RES_READ_AUTOCORR_STATE HEADER DATA...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 3.2.5 - Selection of the serial baudrate. It is possible to modify the serial link baudrate, between WaveCard local and its host. In this case, the baudrate is updated only after the current exchange finished (i.e. that the response at the request of modification is done with the same baudrate as the request).
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 3.2.6 - Reading the firmware version of the WaveCard The reading commands of the firmware version, are as follows : NAME DESCRIPTION 0xA0 REQ_FIRMWARE_VERSION Request to read the radio board firmware version. 0xA1 RES_FIRMWARE_VERSION Response from the radio board to the firmware version reading. Remark : In the command byte coding, the Response frame type are taking the Request command byte value with the LSB bit set to 1.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 3.2.7 - Reading the RSSI level (Received Signal Strengh Indicator) The RSSI level represent the QOS level (Quality Of Service) from a given module. This value can be used to verify the quality of the signals forwarding on the network. It is possible to take this measurement on a distant module, or the local module.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw b) Format of the commands ➢ Request to read RSSI level from a remote equipment : This measurement gives RSSI level of a signal received by a distant equipment, coming from the local WaveCard. Request REQ_READ_REMOTE_RSSI HEADER DATA 3 bytes...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 3.2.8 - TEST Mode This mode is used for tests of installation, or a characterization of defect. a) Command NAME DESCRIPTION 0xB0 MODE_TEST Position the WaveCard module in a test mode b) Format of the command MODE_TEST HEADER DATA 3 bytes...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 4. SERVICE 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 : ...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 4.2- Request types The transmitter send a service command including a type of request. Each request type, has an associated type of response which is included in the command SERVICE_RESPONSE. In the command byte coding, the Response type are taking the Request command byte value with the LSB bit set to 1.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 4.3- Presence detection principle between WAVECARD Before establishing a data exchange with a distant equipment, it can be useful to check the presence and the link budget of this device. The Get_Type Command sent like a « Service Command » allows the distant Wavecard to process an answer independently of the host equipment connected.
During this phase, the RS232 serial connection is not managed. This command is more specifically intended for the reading of CORONIS SYSTEMS telemetry equipment (temperaturemeasurement, moisture, flow, level, management of difital states ...) 5.1.1 - Configuration of the parameters relating to the 'Frame Exchange' mode The parameters are accessible by commands REQ_READ_RADIO_PARAM, and REQ_WRITE_RADIO_PARAM (all the parameters are developed in appendix 3).
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.1.2 - Description of the commands, and their formats NAME DESCRIPTION 0x20 REQ_SEND_FRAME Request to send a radio frame with the waiting for the radio response. Response from the radio board to the frame emission (response to the 0x21 RES_SEND_FRAME request 0x20, 0x22, 0x24, 0x26, 0x28, 0x2A)
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.1.3 - Use of the Relaying mode The relaying mode is only available for point-to-point exchanges ('Frame Exchange' or 'Message' types). a) On frame transmission To send a request in Relaying mode to a distant equipment, it is necessary to configure the list of the repeaters, via parameter RELAY_ROUTE.
Page 39
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw ➢ Response received by the host, with RELAY_ROUTE_STATUS deactivated RECEIVED_FRAME HEADER DATA 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte data from received frame Radio address from 0x30 the maximum size ( N bytes) is defined 0xFF ;...
Page 40
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw Frame RECEPTION_ERROR format ➢ With this command, the local WaveCard informs its host that a problem appeared at the time of the radio exchange. This command is forwarded only on the serial link, between the wavecard and its host, it thus does not require an address of recipient.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.1.4 - Time-out management when sending a request with waiting of a response (Frame Exchange), the timeout relating to waiting of the response frame, is given by parameter RADIO_USER_TIMEOUT (2 seconds by default). The beginning of counting of this timeout depends on another parameter: RADIO_ACKNOWLEDGE. If RADIO_ACKNOWLEDGE is active, then counting begins on reception of the acknowledgement from the Request.
Page 42
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw Diagram in Relaying mode • In the case of the Relaying mode, the time-out from the transmitter point of view is longer than in Point-to- point mode, because of the transit via the relays. Time-out RADIO_USER_TIMEOUT is always applied, but does not take into account the relays. This time value will be applied by the last relay, before the recipient (R2 Delta = Radio_User_Timeout).
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.2- 'Message’ Mode This type of radio exchange allows to send a request, without awaiting 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.
Page 44
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw The format of the types of frame received by the host, are described as follow. Request in 'Message' mode ➢ REQ_SEND_MESSAGE HEADER DATA 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte Radio address from n bytes of data to transmit 0xFF ;...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.2.3 - Use of the Relaying mode The relaying mode is only available for point-to-point exchanges ('Frame Exchange' or 'Message' types). a) On frame transmission To send a request in Relaying mode to a distant equipment, it is necessary to configure the list of the repeaters, via parameter RELAY_ROUTE.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw ➢ Response received by the host, with RELAY_ROUTE_STATUS activated RECEIVED_FRAME_RELAYED HEADER DATA 3 bytes 1 byte 6 bytes 1 byte variable variable 2 bytes 1 byte Radio Radio Number of data from received frame address from addresses of 0xFF ;...
Page 47
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw With RELAY_ROUTE_STATUS parameter activated ( = 0x01 ) ➢ Frame RECEPTION_ERROR format With this command, the local WaveCard informs its host that a problem appeared at the time of the radio exchange. This command is forwarded only on the serial link, between the wavecard and its host, it thus does not require an address of recipient.
Page 48
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw In 'relaying' mode RECEPTION_ERROR HEADER DATA 3 bytes 1 byte 1 byte 1 byte 1 byte 2 bytes 1 byte EXCHANGE_MODE : 0x02 RELAY_COUNTER : Default value for = 0x03 No response from the third repeater; 0xFF ;...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.3- ’Polling’ Mode This mode allows to address a request to a list of predefined distant equipment. The response is sent to the host, transmitter of the request, when all the distant equipments responded; or on timeout. Two types of exchanges in polling mode can be distinguished, ...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.3.2 - Description of the commands, and their formats NAME DESCRIPTION Response from the radio board to the frame emission (response to 0x21 RES_SEND_FRAME the request 0x20, 0x22, 0x24, 0x26, 0x28, 0x2A) 0x26 REQ_SEND_POLLING Request to send a radio frame with the polling mode. 0x32 RECEIVED_FRAME_POLLING Received radio frame following a REQ_SEND_POLLING request...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.3.3 - Difference between selective, and not-selective Polling mode Generally, the use of the polling mode (selective, or not-selective) requires the configuration of a table containing the addresses of the modules to be interrogated (POLLING_ROUTE). When using the selective polling mode, it is necessary to configure on the transmitter side, the group number of modules to be interrogated.
Page 52
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw Principle of the selective Polling mode ➢ Only the modules which belong to the interrogated group are synchronized on the transmitter. A module will respond to a selective polling request only on the following conditions : it belongs to the interrogated group, ...
Page 53
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw Example of a selective polling exchange : Grp 2 Grp 1 Grp 1 Grp 1 Grp 2 Host WaveCard WaveCard is configured like described below, POLLING_ROUTE GROUP_NUMBER Equipment A address 0x01 Equipment B address Equipment C address Equipment D address Equipment E address After transmitting the REQ_SEND_POLLING request, the distant equipments react in the following way:...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.3.4 - Diagram of an exchange in polling mode the following example describes the typical case where the distant WaveCards communicate with their respective host. Indeed, when sending a GET_TYPE request (see chapter XXX) in polling mode; distant WaveCards respond without preliminary dialogue with their host.
Page 55
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw The low level commands are necessary to recover the RECEIVED_FRAME_POLLING responses. Indeed, an index is incremented with each reception of a polling response. And when the WaveCard, instigator of the polling exchange does not await new responses anymore, it sends to its host a first RECEIVED_FRAME_POLLING command ;and will await a low level acknowledgement to decrease its index, and to send next RECEIVED_FRAME_POLLING command.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.4- ’Broadcast’ mode This mode allows to address a request to all the equipments in radio range of the transmitter. Thus, it is not necessary to specify the address of the distant equipment to reach. Depending on the command used, the request can be sent with, or without awaiting for a response ( REQ_SEND_BROADCAST, or REQ_SEND_BROADCAST_MESSAGE commands).
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw b) Example of operations during a broadcast exchange, without waiting for responses Reception of the END_MESSAGE_EXCHANGE command depends on the activation of the EXCHANGE_STATUS parameter (0x0E). This command allows the equipment host to know exactly the moment from which WaveCard is available for communication RS232. 5.4.3 - 'BroadCast' mode with waiting for responses After transmitting a broadcast request, the WaveCard begins a reception phase during which it will memorize all the responses.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw b) Example of operations during a broadcast exchange, with waiting for responses Reception of the END_MESSAGE_EXCHANGE command depends on the activation of the EXCHANGE_STATUS parameter (0x0E). This command allows the equipment host to know exactly the moment from which WaveCard is available for communication RS232. WaveCard user handbook page 58 of 67...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.4.4 - Format of the commands – from the request transmitter side ➢ Broadcast requests – 0x28 ou 0x2A (REQ_SEND_BROADCAST or REQ_SEND_BROADCAST_MESSAGE) REQ_SEND_BROADCAST ou REQ_SEND_BROADCAST_MESSAGE HEADER DATA 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte Group number to interrogate in n bytes of data to transmit 0xFF ;...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw 5.4.5 - Format of the commands – from the request receiver side ➢ Reception of a broadcast request – 0x38 (RECEIVED_BROADCAST_FRAME) RECEIVED_BROADCAST_FRAME HEADER DATA 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte Radio address of the transmitter of n bytes of data 0xFF ;...
5.5- ’Multi frames' Mode 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, ...). Le mode multitrames a été developpé pour permettre le dialogue entre une WaveCard/ WavePort et un module CORONIS de télémétrie.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw APPENDIX 2 : Electric interface of the WAVECARD WaveCard - 25mW ➢ PIN # PIN NAME DESCRIPTION INPUT / OUTPUT TX RS232 signal OUTPUT RX RS232 signal INPUT RESET RESET input (active to high level) INPUT OUT2 Not used OUTPUT OUT1...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw APPENDIX 3 : List of the functional parameters Parameter Description Value Size number (bytes) Period in multiples of 100ms AWAKENING_PERIOD : polling period of RF medium radio, in 0x00 (by default, 0x0A for one second) multiples of 100ms 0 = quasi-permanent reception (every 20ms) 0 : long Wake Up (default setting) 0x01...
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw APPENDIX 4 : List of the commands of parameters setting Name Description 0x40 REQ_WRITE_RADIO_PARAM Request to update the radio parameters 0x41 RES_WRITE_RADIO_PARAM Response from the radio board to the radio parameters update 0x42 REQ_CHANGE_UART_BDRATE Request to update serial link Baudrate Response from the radio board to the serial link baudrate update.
Document : CS-SUP-MUTI-WPORTAPP-E02.sxw APPENDICE 5 : List of the commands of data transmission NAME DESCRIPTION 0x20 REQ_SEND_FRAME Request to send a radio frame with the waiting for the radio response. Response from the radio board to the frame emission (response to the request 0x20, 0x21 RES_SEND_FRAME 0x22,0x24, 0x26, 0x28, 0x2A )
Need help?
Do you have a question about the WaveCard 25mW and is the answer not in the manual?
Questions and answers