background image

Document : CS-SUP-MUTI-WPORTAPP-E02.sxw

WaveCard user handbook

page 1 of 67

Summary of Contents for WaveCard 25mW

Page 1: ...Document CS SUP MUTI WPORTAPP E02 sxw WaveCard user handbook page 1 of 67...

Page 2: ...aveCard 500mW Compatible with the version v4 01 and later This device complies with part 15 of the FCC rules Operation is subject to the following two conditions this device may not cause harmful inte...

Page 3: ...el 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 t...

Page 4: ...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...

Page 5: ...res 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 le...

Page 6: ...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 b...

Page 7: ...fix 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 exampl...

Page 8: ...X LENGTH CMD DATA CRC ETX 1 byte 1 byte 1 byte 1 byte De 0 250 bytes 2 bytes 1 byte Synchro character Start of transmission character Frame length Command Data Control Redundancy Check LSB First End o...

Page 9: ...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 t...

Page 10: ...OR Error frame Sent by the receiver after reception of a Request response frame understood but not supported Byte 1 0x01 unknown command 2 3 2 Applicative type commands The applicative type commands u...

Page 11: ...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 repe...

Page 12: ...ment 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 equipment Process a link budget with a dist...

Page 13: ...d in multiples of 100ms by default 0x0A for one second 0 quasi permanent reception every 20ms 1 0x01 WAKEUP_TYPE Wake Up type used during a frame emission 0 long Wake Up default setting 1 short Wake U...

Page 14: ...ed Default value SWITCH_MODE_STATUS 0x00 1 0x16 WAVECARD_MULTICAST_GROUP Byte containing the Multicast Group of the Wavecard available from V2 00 version By default no group selected 0xFF 1 0x17 BCST_...

Page 15: ...read ok Status 0x01 read error Parameter number value 0x03 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...

Page 16: ...STX LENGTH CMD DATA Parameter number Parameter data CRC ETX 0xFF 0x02 0x0C 0x40 0x07 0x01 0xAAAAAAAAAAAA 0xXXXX 0x03 Response from the WaveCard to the host RES_WRITE_RADIO_PARAM HEADER SYNC STX LENGTH...

Page 17: ...ng period of RF medium radio in multiples of 100ms Period in multiples of 100ms by default 0x0A for one second 0 quasi permanent reception every 20ms 1 0x01 WAKEUP_TYPE Wake Up type used during a fram...

Page 18: ...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 WaveCar...

Page 19: ...er is already in phase of reception Exchange without radio acknowledge Exchange with radio acknowledge Configuration example of the parameters of wakeup management during an exchange between two WaveC...

Page 20: ...annel when FHSS is deselected 0x61 RES_SELECT_CHANNEL Response to the channel selection request 0x62 REQ_READ_CHANNEL Request to read the radio operating channel when FHSS is deselected 0x63 RES_READ_...

Page 21: ...HANNEL 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 Response from the WaveCard to the host RES_SELECT_CHANNEL HEADER CMD DATA CRC ETX 3...

Page 22: ...ct 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 Res...

Page 23: ...05 0x65 Status 0x00 update OK 0x01 update error 0x03 c Automatic selection of Radio physical mode to use A parameter allows the WaveCard to choose its mode of transmission according to the radio addre...

Page 24: ...4 REQ_CHANGE_TX_POWER Request to update radio board emission power 0x45 RES_CHANGE_TX_POWER Response from the radio board to the emission power update 0x54 REQ_READ_TX_POWER Request to read radio boar...

Page 25: ...CRC ETX 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 CMD DATA CRC ETX 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF 0x02 0x05 0x55...

Page 26: ...to the WAVENIS RF ASIC autocorrection state update 0x5A REQ_READ_AUTOCORR_STATE Request to read WAVENIS RF ASIC RSSI Threshold autocorrection state 0x5B RES_READ_AUTOCORR_STATE Response from the radi...

Page 27: ...ATE HEADER CMD CRC ETX 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 CMD DATA CRC ETX 3 bytes 1 byte 1 byte 1 byte 2 byte...

Page 28: ...TION 0x42 REQ_CHANGE_UART_BDRATE Request to update serial link Baudrate 0x43 RES_CHANGE_UART_BDRATE Response from the radio board to the serial link baudrate update Serial Link Baudrate is updated onc...

Page 29: ...format Request from the host to the WaveCard REQ_FIRMWARE_VERSION HEADER CMD CRC ETX 3 bytes 1 byte 2 bytes 1 byte 0xFF 0x02 0x04 0xA0 0x03 Response from the WaveCard to the host RES_FIRMWARE_VERSION...

Page 30: ...SI level on signal 2 reception by the local equipment Example 2 Request of reading of RSSI level on a distant module in relaying mode REQ_READ_REMOTE_RSSI request the RSSI level of the signal 1 Theref...

Page 31: ...tion of the frame resulting from the wavecard 0x03 Request to read RSSI level from the local equipment This measurement gives RSSI level of a signal received by the local Wavecard coming from a distan...

Page 32: ...tion the WaveCard module in a test mode b Format of the command MODE_TEST HEADER CMD DATA CRC ETX 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF 0x02 0x05 0xB0 Test mode value 0x03 With Test Mode Value Des...

Page 33: ...REQ_SEND_SERVICE 0x82 SERVICE_RESPONSE Received radio frame consecutive to a REQ_SEND_SERVICE transmission Service request REQ_SEND_SERVICE HEADER CMD DATA CRC ETX 3 bytes 1 byte 6 bytes 1 byte variab...

Page 34: ...to read equipment type and RSSI Level from distant equipment No parameter GET_FW_VERSION 0x28 Command used to read distant equipment firmware version No parameter Response type RESPONSE TYPE NAME VALU...

Page 35: ...e request REQ_SEND_SERVICE HEADER CMD DATA CRC ETX 3 bytes 1 byte 6 bytes 1 byte 2 bytes 1 byte 0xFF 0x02 0x0B 0x80 Radio address of distant radio equipment 0x20 GET_TYPE 0x03 Response to the service...

Page 36: ...RADIO_PARAM all the parameters are developed in appendix 3 NUM DESCRIPTION VALUE SIZE in bytes 0x04 RADIO_ACKNOWLEDGE indicates if the radio frames must be acknowledged by the receiver 0 no acknowledg...

Page 37: ...in Frame Exchange mode REQ_SEND_FRAME HEADER CMD DATA CRC ETX 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte 0xFF 0x02 0xXX 0x20 Radio address from equipment to reach n bytes of data to transmit the...

Page 38: ...ally if the frame arriving to the recipient went up towards his Host then the list of the relay addresses for the return must be configured by the user If the frame did not go up towards the Host of t...

Page 39: ...3 bytes 1 byte 6 bytes 1 byte variable variable 2 bytes 1 byte 0xFF 0x02 0xXX 0x35 Radio address from transmitter equipment Number of repeaters used Radio addresses of the repeaters used data from re...

Page 40: ...Point to Point mode ERROR_TYPE 0x01 Distant equipment RF acknowledge not received useful if acknowledge mechanism is set 0x02 Distant equipment RF response not received 0x03 In Relaying mode RECEPTION...

Page 41: ...er parameter RADIO_ACKNOWLEDGE If RADIO_ACKNOWLEDGE is active then counting begins on reception of the acknowledgement from the Request On the other hand if RADIO_ACKNOWLEDGE is inactive then the coun...

Page 42: ...is configured in the transmitter and not in the relay itself In fact in relaying mode the relay use a value of RADIO_USER_TIMEOUT encapsulated in the radio frame by the transmitter The relay is not u...

Page 43: ...TE 1 number of repeaters in the route Maximum repeater number 3 If BYTE 1 0 BYTES 2 7 First repeater radio address and so on 1 19 0x0E EXCHANGE_STATUS parameter relative to the error or status frame m...

Page 44: ...f data Acknowledgement of the request RES_SEND_FRAME HEADER CMD DATA CRC ETX 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF 0x02 0x05 0x21 Status 0x00 transmission OK 0x01 transmission error 0x03 Status fr...

Page 45: ...e reception Since the firmware version v2 00 v4 00 for 500mW equipment it is possible on frame reception in relaying mode to make go up the relay route towards the host of the receiving module To pres...

Page 46: ...used data from received frame the maximum size N bytes is defined below 0x03 The field Radio addresses of the repeaters used can have a size of 6 12 or 18 bytes according to the number of repeaters us...

Page 47: ...it thus does not require an address of recipient Note The error messages are activated only if parameter EXCHANGE_STATUS is positioned with 0x01 or 0x03 In Point to Point mode RECEPTION_ERROR HEADER...

Page 48: ...3 Note In the MESSAGE mode the error frame intervene only between the transmitter and the first repeater Even if the other repeaters return errors the transmitting module does not await an answer and...

Page 49: ...o address to be addressed Byte 2 number of equipments to interrogate IF Byte 2 0 Bytes 3 to 8 radio address of the first module and so on 1 241 0x09 GROUP_NUMBER Byte containing the number of the grou...

Page 50: ...s of data to transmit the maximum size is 152 bytes 0x03 Remark in radio polling mode it is not necessary to transmit the address of the modules to be interrogated since they must be configured by the...

Page 51: ...lling mode where all the modules included in the list will be interrogated Principle of the not selective polling mode When using a not selective polling all the modules within radio range are synchro...

Page 52: ...reading time depends on the index of precision max 3 seconds The procedure to be followed to initiate a request in selective polling mode is To configure table POLLING_ROUTE with all the addresses of...

Page 53: ...following way Equipment A responds to the request PARTICULAR CASE this module is the first of table POLLING_ROUTE and the first polling frame is sent in point to point mode Equipment B responds to the...

Page 54: ...out is started configured by POLLING_TIME parameter and if the equipment doesn t respond before the end of the timeout 1 second by default then the transmitter send the same radio frame to the next di...

Page 55: ...sponses 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 The followi...

Page 56: ...both status and error frames activated by default RECEPT_ERROR_STATUS 0x00 1 0x17 BCST_RECEPTION_TIMEOUT timeout used for the reception of CSMA frame consecutively to REQ_SEND_BROADCAST Command emiss...

Page 57: ...er timeout the WaveCard send the responses towards its host via the serial link connection frame after frame a Description of the commands CMD NAME DESCRIPTION 0x21 RES_SEND_FRAME Response from the ra...

Page 58: ...h 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...

Page 59: ...bytes 1 byte 0xFF 0x02 0x05 0x21 Status 0x00 transmission OK 0x01 transmission error 0x03 Response to the broadcast request 0x34 RECEIVED_BROADCAST_RESPONSE RECEIVED_BROADCAST_RESPONSE HEADER CMD DATA...

Page 60: ...the Broadcast frame Use of this command in any other circumpstances could make the Wavecard not available during a few seconds Status Message 0x37 END_MESSAGE_EXCHANGE END_MESSAGE_EXCHANGE HEADER CMD...

Page 61: ...restored to host equipment with serial link when RF reception is ended The multi frame mechanism is initiate by distant equipment depending on the quantity of data to transmit following a point to poi...

Page 62: ...Document CS SUP MUTI WPORTAPP E02 sxw APPENDIX 1 Mechanical description of the WAVECARD WaveCard 25mW WaveCard user handbook page 62 of 67...

Page 63: ...Document CS SUP MUTI WPORTAPP E02 sxw WaveCard 500mW WaveCard user handbook page 63 of 67...

Page 64: ...ltage 10mA available OUTPUT 8 SUPPLY VOLTAGE input supply voltage 4V to 5 5V minimum current 45mA INPUT WaveCard 500mW PIN PIN NAME DESCRIPTION INPUT OUTPUT 1 TX TX RS232 signal 0 2 7Vmax OUTPUT 2 RX...

Page 65: ...ers in the route Maximum repeater number 3 If BYTE 1 0 BYTES 2 7 First repeater radio address and so on 1 19 0x08 POLLING_ROUTE Table containing the list of modules radio address to be addressed BYTE...

Page 66: ...NIS RF ASIC RSSI Threshold autocorrection state 0x5B RES_READ_AUTOCORR_STATE Response from the radio board to the WAVENIS RF ASIC autocorrection state reading 0x60 REQ_SELECT_CHANNEL Request to select...

Page 67: ...sponse 0x30 RECEIVED_FRAME Received radio frame by the radio board 0x31 RECEPTION_ERROR Frame indicating error type detected at the issue of last exchange in point to point or relaying mode 0x32 RECEI...

Reviews: