background image

Wavecard-Waveport User Manual

Coronis Systems

Wavecard - Waveport

User Manual

 

Coronis Systems

Waveport , Wavecard 25 mW and 500 mW products

CS-SUP-MUTI-WPORTAPP-E04

1

Summary of Contents for Wavenis Wavecard

Page 1: ...Wavecard Waveport User Manual Coronis Systems Wavecard Waveport User Manual Coronis Systems Waveport Wavecard 25 mW and 500 mW products CS SUP MUTI WPORTAPP E04 1...

Page 2: ...ITSELF AND ITS SUPPLIERS ANY LIABILITY WHETHER BASED IN CONTRACT OR TORT INCLUDING NEGLIGENCE FOR DIRECT INCIDENTAL CONSEQUENTIAL INDIRECT SPECIAL OR PUNITIVE DAMAGES OF ANY KIND OR FOR LOSS OF REVEN...

Page 3: ...Wavecard 25 mW 2 01 and higher Wavecard 500 mW 4 01 and higher FCC APPROVAL This module complies with part 15 of the FCC rules Operation is subject to the following two conditions this module may not...

Page 4: ...ater table and activating error frames 18 3 2 Wake up and synchronization 19 3 2 1 Transmitting and receiving frames 19 3 2 2 Examples of different wake up conditions 20 3 2 3 Example of point to poin...

Page 5: ...t mode 57 5 4 1 Configuring broadcast mode parameters 57 5 4 2 Using broadcast mode without waiting for response 58 5 4 3 Using broadcast mode waiting for responses 59 5 4 4 Command format from the tr...

Page 6: ...wireless board Therefore this document covers both products as well as Waveport module with serial USB or compact flash connectors We will generally refer to Wavecard except where there are specific...

Page 7: ...s allows you to use Wavecard as a wireless modem that can be integrated into existing modules or driven by a specific host module with its own micro controller As mentioned above this document is vali...

Page 8: ...dio board can do it Figure 2 Overview of data exchange between a Waveport modem and host 2 1 1 Low level acknowledgement Serial frames exchanged between a host and radio board are always managed by an...

Page 9: ...RF board following the request frame command prefix REQ sent by the host Request frames are identified by REQ_XXX_XXX i e REQ_SEND_FRAME High level acknowledgement frames are identified by RES_XXX_XXX...

Page 10: ...SYNC STX LENGTH CMD DATA CRC ETX 1 byte 1 byte 1 byte 1 byte 0 250 bytes 2 bytes 1 byte Sync character Start of transmission character Frame length Command Data Control Redundancy Check LSB First End...

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

Page 12: ...rame that was not understood No data field 0x00 ERROR Error frame Sent by the receiver after receiving a request response frame that was understood but not supported Byte 1 0x01 unknown command 2 3 2...

Page 13: ...232 link This command may be used for simple data transfer between Wavecard modules Relay mode When a remote module is beyond a transmitting module s radio range relay mode may be used to forward fram...

Page 14: ...nnected host equipment When a Wavecard recognizes a service command no data is sent to the connected host These commands are mainly used to handle Detection of remote RF modules Link budgets with resp...

Page 15: ...es of 100ms by default 0x0A for one second max 10 sec 0 nearly constant reception every 20ms 1 0x01 WAKEUP_TYPE wake up type used during frame transmission 0 long wake up default setting 1 short wake...

Page 16: ...selection deactivated 1 automatic selection activated Default SWITCH_MODE_STATUS 0x01 1 0x16 WAVECARD_MULTICAST_GROUP byte containing the Wavecard multicast group starting with version 2 00 By defaul...

Page 17: ...tus 0x01 read error value 0x03 Request to update 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 paramete...

Page 18: ...ater list Host request to the Wavecard REQ_WRITE_RADIO_PARAM HEADER SYNC STX LENGTH CMD DATA Parameter number Parameter data CRC ETX 0xFF 0x02 0x0C 0x40 0x07 0x01 0xAAAAAAAAAAAA 0xXXXX 0x03 Wavecard r...

Page 19: ...sponding to a point to point request Duration is 50ms and cannot be changed NUM DESCRIPTION VALUE SIZE in bytes 0x00 AWAKENING_PERIOD RF polling period in multiples of 100 ms Period in multiples of 10...

Page 20: ...icity but not carried out At the end of the the wake up phase the transmitter modules sends a synchronization sequence followed by the data to be transmitted 3 2 2 Examples of different wake up condit...

Page 21: ...same manner as before However in this case the transmitter waits for a response after sending the data The time out period for this can be configured using the RADIO_USER_TIMEOUT parameter 0x0C After...

Page 22: ...period to 0 nearly constant reception 2 Set the transmitter s WakeUp_Length parameter to 40 ms 3 Send the data to the receiver 4 Send a parameter modification command to the receiver to set its wake u...

Page 23: ...IPTION 0x64 REQ_SELECT_PHYCONFIG Request to select RF communication mode 0x65 RES_SELECT_PHYCONFIG Response to communication mode selection request 0x66 REQ_READ_PHYCONFIG Request to read RF communica...

Page 24: ...ecard to host RES_SELECT_PHYCONFIG HEADER CMD DATA CRC ETX 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF 0x02 0x05 0x65 Status 0x00 Update OK 0x01 Update error 0x03 Automatic selection of communication mo...

Page 25: ...ng radio channel when FHSS is deselected 0x63 RES_READ_CHANNEL Response to the read channel request These commands are used only when the radio communication mode is mono frequency with channel select...

Page 26: ...ted in the table below By default the level is set to 14 dBm Parameter value 0x0A 0x09 0x08 0x07 0x06 0x05 0x04 0x03 0x02 0x01 0x00 Power level dBm 14 12 11 9 7 7 9 5 5 3 3 2 1 0 3 4 16 The output pow...

Page 27: ...3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF 0x02 0x05 0x45 Status 0x00 Update OK 0x01 Update error 0x03 Format of commands for reading transmission power Request host to Wavecard REQ_READ_TX_POWER HEADE...

Page 28: ...read threshold auto correction state 0x5B RES_READ_AUTOCORR_STATE Radio board response to threshold auto correction state read Note In command byte coding response frames reuse the request command wi...

Page 29: ...baud rate change is issued at the same baud rate as the request By default the serial link baud rate is 9600 baud value 0x00 Parameter value 0x00 0x01 0x02 0x03 0x04 Baud rate 9 600 baud 19 200 baud...

Page 30: ...adio board response to firmware version reading In command byte coding response frames reuse the request command with the LSB bit set to 1 Wavecard can be considered to be in an error state if more th...

Page 31: ...vel RSSI represents the Quality Of Service QOS level for a given Wavecard module This value can be used to verify signal quality in a given mesh network You may measure RSSI on local or remote modules...

Page 32: ...SI level of a remote module This measurement gives the remote module s RSSI level Request REQ_READ_REMOTE_RSSI HEADER CMD DATA CRC ETX 3 bytes 1 byte 6 bytes 2 bytes 1 byte 0xFF 0x02 0x0A 0x68 Remote...

Page 33: ...ying anomalies Command CMD NAME DESCRIPTION 0xB0 MODE_TEST Set WaveCard into test mode Command format MODE_TEST HEADER CMD DATA CRC ETX 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF 0x02 0x05 0xB0 Test mo...

Page 34: ...ICE response 0x82 SERVICE_RESPONSE Frame received following REQ_SEND_SERVICE transmission Service request REQ_SEND_SERVICE HEADER CMD DATA CRC ETX 3 bytes 1 byte 6 bytes 1 byte variable 2 bytes 1 byte...

Page 35: ...Command used to read equipment type and RSSI level from remote equipment n a GET_FW_VER SION 0x28 Command used to read firmware version in remote module n a Response type RESPONSE TYPE NAME VALUE DESC...

Page 36: ...ame Service 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 remote module 0x20 GET_TYPE 0x03 Service request response...

Page 37: ...Frame exchange parameters are accessible REQ_READ_RADIO_PARAM and REQ_WRITE_RADIO_PARAM Parameter details are provided in Appendix III of this guide NUM DESCRIPTION VALUE SIZE in bytes 0x04 RADIO_ACKN...

Page 38: ...in point to point or relay mode 0x35 RECEIVED_FRAME_RELAYED Relay frame received by the radio board Reception of this command is possible only if the RELAY_ROUTE_STATUS 0x06 parameter is set Here is a...

Page 39: ...f the response from the remote module is not automatic it must be configured by the application running on the remote module Generally speaking if a frame is received in a remote module and transferre...

Page 40: ...below 0x03 The field containing the radio addresses of the repeaters can be 6 12 or 18 bytes depending on the number of repeaters used Defining maximum size Point to Point mode Max 152 bytes of data R...

Page 41: ...No response from end point module 0x03 In both cases the procedure for sending an error frame depends on the RADIO_ACKNOWLEDGE parameter If RADIO_ACKNOWLEDGE is active and the transmitter does not rec...

Page 42: ...nual Coronis Systems Point to Point exchange CS SUP MUTI WPORTAPP E04 42 Delta 1 RADIO_USER_TIMEOUT with RADIO_ACKNOWLEDGE disabled Delta 2 RADIO_USER_TIMEOUT with RADIO_ACKNOWLEDGE enabled Delta 1 De...

Page 43: ...eout The value of RADIO_USER_TIMEOUT applied by the last repeater is configured in the transmitter not in the repeater itself In relay mode repeaters use the RADIO_USER_TIMEOUT value encapsulated in t...

Page 44: ...ach the end module BYTE 1 number of repeaters in route Maximum number of repeaters 3 If BYTE 1 0 BYTES 2 to 7 Radio address of first repeater etc 1 to 19 0x0E EXCHANGE_STATUS parameter for activating...

Page 45: ...acknowledgement 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 frame 0x37 END_MESSAGE_...

Page 46: ...der to send another request in relay mode Here is an example of sending a REQ_SEND_MESSAGE request in relay mode Note Recipients don t respond to REQ_SEND_MESSAGE requests Frame reception Starting wit...

Page 47: ...RELAYED HEADER CMD DATA CRC ETX 3 bytes 1 byte 6 bytes 1 byte variable variable 2 bytes 1 byte 0xFF 0x02 0xXX 0x35 Radio address of transmitting module Number of repeaters used Radio addresses of repe...

Page 48: ...Wavecard Waveport User Manual Coronis Systems Relay mode diagram With RELAY_ROUTE_STATUS parameter deactivated 0x00 With RELAY_ROUTE_STATUS parameter activated 0x01 CS SUP MUTI WPORTAPP E04 48...

Page 49: ...ION_ERROR HEADER CMD DATA CRC ETX 3 bytes 1 byte 1 byte 1 byte 1 byte 2 bytes 1 byte 0xFF 0x02 0x06 0x31 EXCHANGE_MODE 0x02 relay mode 0x02 Default value for relay mode RELAY_COUNTER 0x03 No response...

Page 50: ...dresses of remote modules to query Byte 2 number of modules to query IF Byte 2 0 Bytes 3 to 8 radio address of the first module second module etc 1 to 241 0x09 GROUP_NUMBER Byte containing the group n...

Page 51: ...XX 0x26 N bytes of data to transmit Maximum size is 152 bytes 0x03 In radio polling mode you do not have to transmit the addresses of the modules you wish to query as they must be configured using the...

Page 52: ...uded in the table with the same group number as that configured in the transmitter This is different from non selective polling mode where all modules included in the list will be queried Principle of...

Page 53: ...ule will respond to a selective polling request if It belongs to the queried group Its radio address is contained in the list of queried modules POLLING_ROUTE Since it doesn t use long WakeUp synchron...

Page 54: ...is parameter with the parameter GROUP_NUMBER which gives the number of group to be queried when Wavecard transmits a selective polling request Example of a selective polling exchange Wavecard is confi...

Page 55: ...hout preliminary dialogue with their host POLLING_TIME a time out is started set by POLLING_TIME after the radio frame is transmitted If modules do not respond before the end of the time out by defaul...

Page 56: ...x is incremented upon reception of each polling response When the WaveCard that initiated the polling exchange is not longer expecting new responses it sends its host a first RECEIVED_FRAME_POLLING co...

Page 57: ...oadcast only queries a given group of modules within radio range 5 4 1 Configuring broadcast mode parameters Parameters are accessible using REQ_READ_RADIO_PARAM and REQ_WRITE_RADIO_PARAM commands all...

Page 58: ...to 0x20 0x22 0x24 0x26 0x28 0x2A request 0x2A REQ_SEND_BROADCAST_MESSA GE Request to send a radio frame in broadcast mode without waiting for radio response 0x37 END_MESSAGE_EXCHANGE Frame indicating...

Page 59: ...E DESCRIPTION 0x21 RES_SEND_FRAME Radio board response to frame transmission response to 0x20 0x22 0x24 0x26 0x28 0x2A request 0x24 REQ_SEND_BROADCAST_RESPONSE Request to send a radio frame in respons...

Page 60: ...dcast exchange waiting for responses Reception of the END_MESSAGE_EXCHANGE command depends on the EXCHANGE_STATUS parameter 0x0E This command allows host equipment to know exactly when the Wavecard is...

Page 61: ...F 0x02 0x05 0x21 Status 0x00 Transmission OK 0x01 Transmission error 0x03 Response to broadcast request 0x34 RECEIVED_BROADCAST_RESPONSE RECEIVED_BROADCAST_RESPONSE HEADER CMD DATA CRC ETX 3 bytes 1 b...

Page 62: ...able 2 bytes 1 byte 0xFF 0x02 0xXX 0x24 Radio address of the request transmitter n bytes of data to transmit Maximum size is 152 bytes 0x03 This command can only be used after receiving a broadcast fr...

Page 63: ...ve their GROUP_NUMBER parameter configured Simply issue a broadcast request with or without waiting for responses with group number configured to adjust selection Group number 0xFF 0xXX 0xXX 0xXX 0xXX...

Page 64: ...point to point request from a Wavecard module 5 5 2 Received frame format Multi frame reception 0x36 RECEIVED_MULTIFRAME HEADER CMD DATA CRC ETX 3 bytes 1 byte 1 byte 1 byte 1 byte 6 bytes variable 2...

Page 65: ...Wavecard Waveport User Manual Coronis Systems Appendix I Wavecard physical layout 25mW Wavecard CS SUP MUTI WPORTAPP E04 65...

Page 66: ...Wavecard Waveport User Manual Coronis Systems 500mW Wavecard CS SUP MUTI WPORTAPP E04 66...

Page 67: ...t voltage 10mA available OUTPUT 8 SUPPLY VOLTAGE Input supply voltage 3 3V to 4 5V Minimum current 45mA INPUT 500mW WaveCard PIN PIN NAME DESCRIPTION INPUT OUTPUT 1 TX TX RS232 signal 0 2 7Vmax OUTPUT...

Page 68: ...number of repeaters in route Maximum number of repeaters 3 If BYTE 1 0 BYTES 2 7 First repeater radio address etc 1 to 19 0x08 POLLING_ROUTE Table containing the list of radio address to be queried BY...

Page 69: ...RF ASIC RSSI threshold auto correction state 0x5B RES_READ_AUTOCORR_STAT E Radio board response to WAVENIS RF ASIC auto correction state reading 0x60 REQ_SELECT_CHANNEL Request to select operating ra...

Page 70: ...nse 0x30 RECEIVED_FRAME Radio frame received by the radio board 0x31 RECEPTION_ERROR Frame indicating error type detected following last exchange in point to point or relay mode 0x32 RECEIVED_FRAME_PO...

Reviews: