1. Manuals
  2. Brands
  3. Coronis Manuals
  4. Microphone system
  5. Wavenis Wavecard
  6. User manual

Coronis Wavenis Wavecard User Manual

Modules of wireless mesh networks
Hide thumbs
Table of Contents

Advertisement

Quick Links

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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Wavenis Wavecard and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Coronis 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...
  • Page 2 Wavenis is a registered trademark, and Wavecard and Waveport, the Coronis Systems logo, and the Wavenis logo are trademarks of Coronis Systems or its subsidiaries. All other product and brand names may be trademarks or registered trademarks of their respective owners.
  • Page 3 Caution: any changes or modifications not explicitly approved by Coronis-Systems could void the user's authority to operate the equipment. CS-SUP-MUTI-WPORTAPP-E04...

  • Page 4: Table Of Contents

    Wavecard-Waveport User Manual Coronis Systems TABLE OF CONTENTS 1. INTRODUCTION.............................6 1.1 Scope of this document..........................7 1.1.1 Terms...............................7 1.1.2 Usage scenarios ..........................7 2. RS232 SERIAL PROTOCOL PRESENTATION.....................8 2.1 Basic data exchange.............................8 2.1.1 Low-level acknowledgement......................8 2.1.2 Request / response mechanism......................9 2.2 Format of exchanged frames........................10 2.2.1 Wake-up and synchronization mechanism..................10...
  • Page 5 Wavecard-Waveport User Manual Coronis Systems 5.1.3 Using relay mode...........................39 5.1.4 Managing time-outs........................41 5.2 Message mode............................44 5.2.1 Configuring message mode parameters..................44 5.2.2 Commands and formats........................44 5.2.3 Using relay mode...........................46 5.3 Polling mode..............................50 5.3.1 Configuring polling mode parameters....................50 5.3.2 Commands and formats.........................51 5.3.3 Selective vs.

  • Page 6: Introduction

    The module is driven through a USART link (RS232 or TTL) by an embedded client application running on a connected host module, or by an application running on a PC (via installed Wavenis drivers). Coronis Systems Wavecard and Waveport products use the same Wavenis wireless board. Therefore, this document covers both products, as well as Waveport module with serial, USB, or compact flash connectors.

  • Page 7: Scope Of This Document

    Wavecard-Waveport User Manual Coronis Systems Scope of this document The purpose of this document is to present: • A low-level description of the exchange protocol used to drive the Wavecard wireless board through an asynchronous serial RS232 (±12V) or TTL level (0-3V) interface •...

  • Page 8: Rs232 Serial Protocol Presentation

    Wavecard-Waveport User Manual Coronis Systems 2. RS232 SERIAL PROTOCOL PRESENTATION This protocol is dedicated to an asynchronous RS232 or TTL link between the host and the radio board. The transmission format is: • 8 data bits • 1 stop bit •...

  • Page 9: Request / Response Mechanism

    Wavecard-Waveport User Manual Coronis Systems 2.1.2 Request / response mechanism Some exchanges require using a request/response mechanism. In this case, a high-level acknowledgement (command prefix: RES) is initiated by the RF board following the request frame (command prefix: REQ) sent by the host.

  • Page 10: Format Of Exchanged Frames

    Wavecard-Waveport User Manual Coronis Systems Format of exchanged frames 2.2.1 Wake-up and synchronization mechanism Wavecard normally stays in standby mode to optimize power consumption, waking up either: • To poll for radio activity periodically • When a serial frame is received from host equipment In order to give the radio board time to wake up, a synchronization character is needed before the data in the serial frame.

  • Page 11: Sample Crc Code (C Language)

    Wavecard-Waveport User Manual Coronis Systems 2.2.3 Sample CRC code (C language) This example shows how to compute CRC on a fixed frame length equal to 9. #include <iostream.h> #include <stdio.h> #include <string.h> void main ( ) Poly = 0x8408; lg = 9;...

  • Page 12: Command Description

    Wavecard-Waveport User Manual Coronis Systems Command description This chapter describes the format of serial bus data frames. The distinction between frames is made using the CMD fields representing the command (or action) to carry out. The types of available commands can be split into three categories: •...
  • Page 13 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, ...).

  • Page 14: Service Commands

    Wavecard-Waveport User Manual Coronis Systems 2.3.3 Service commands Service commands are used to configure a Wavecard or to read radio parameters independently of the connected host equipment. When a Wavecard recognizes a service command, no data is sent to the connected host. These commands are mainly used to handle: •...

  • Page 15: Setting Internal Wavecard Parameters

    Wavecard-Waveport User Manual Coronis Systems 3. SETTING INTERNAL WAVECARD PARAMETERS Internal Wavecard parameters can be separated into two categories: • Control parameters that are carried out by specific types of request/response frames. These parameters (transmission power level, channel selection, etc...) allow you to change the communication mode (either serial and/or RF).

  • Page 16: Format For Accessing Internal Parameters

    Wavecard-Waveport User Manual Coronis Systems BYTE 2: number of modules to query POLLING_ROUTE: Table containing the list of IF BYTE 2 != 0 0x08 1 to 241 module radio address to be queried. BYTES 3 to 8: radio address of the first module..., etc.
  • Page 17 Wavecard-Waveport User Manual Coronis Systems The format for data fields for reading or updating radio parameters is given below: • Request to read radio parameters REQ_READ_RADIO_PARAM HEADER DATA 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF ; 0x02 ; 0x05...

  • Page 18: Example: Configuring Repeater Table And Activating Error Frames

    Wavecard-Waveport User Manual Coronis Systems RES_WRITE_RADIO_PARAM HEADER DATA 3 bytes 1 byte 1 byte 2 bytes 1 byte STATUS 0xFF ; 0x02 ; 0x05 0x41 = 0x00 update OK 0x03 = 0x01 update error 3.1.2 Example: Configuring repeater table and activating error frames In this case there is a repeater module (radio address: 0X AA AA AA AA AA AA) between the Wavecard (initiating the exchange) and the remote module.

  • Page 19: Wake-Up And Synchronization

    Wavecard-Waveport User Manual Coronis Systems Wake-up and synchronization Wavecard optimizes power consumption by using STANDBY mode, waking up periodically to poll for radio activity. The wake-up period is defined by the value of the AWAKENING_PERIOD parameter, expressed in multiples of 100 ms (1 second by default).

  • Page 20: Examples Of Different Wake-Up Conditions

    Wavecard-Waveport User Manual Coronis Systems The periodic wake-up having to occur when waiting of synchronization, are memorized (in order to preserve the periodicity), 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.

  • Page 21: Example Of Point-To-Point Request / Response Exchange

    Wavecard-Waveport User Manual Coronis Systems Case where WakeUp is too long (much higher than the receiver's WakeUp period): 3.2.3 Example of point-to-point request / response exchange When using a point-to-point (request/response) exchange, the request is transmitted in the same manner as before.

  • Page 22: Configuring Control Parameters

    Wavecard-Waveport User Manual Coronis Systems Exchange with radio acknowledgement Example of parameter configuration for wake-up management In this example, the transmitter sends data to the receiver quickly between two relatively long idle periods: 1) Send a parameter modification command to the receiver to modify its WakeUp period to 0 (nearly constant reception).

  • Page 23: Selecting Rf Communication Mode

    Wavecard-Waveport User Manual Coronis Systems 3.3.1 Selecting RF communication mode The following physical layer modes are available: • 868 MHz single channel, 4800 baud • 868 MHz single channel, 4800 baud alarm band • 868 MHz single channel, 9600 baud with channel selection •...
  • Page 24 Wavecard-Waveport User Manual Coronis Systems The table below shows available physical layer modes: Communication mode Value 433 MHz frequency hopping 9600 baud 0x00A1 868 MHz single channel 4800 baud 0x0012 868 MHz single channel 4800 baud Alarm Band 0x0094 868MHz single channel 9600 baud with channel selection...

  • Page 25: Selecting Radio Channel When Fhss Is Deselected

    Wavecard-Waveport User Manual Coronis Systems 3.3.2 Selecting radio channel when FHSS is deselected You may select the Wavecard radio channel using these commands: Name Description Request to select operating radio channel when FHSS is 0x60 REQ_SELECT_CHANNEL deselected 0x61 RES_SELECT_CHANNEL Response to channel selection request...

  • Page 26: Selecting Radio Board Transmission Power

    Wavecard-Waveport User Manual Coronis Systems Format of write commands for channel to use • Request (host to Wavecard) REQ_SELECT_CHANNEL HEADER DATA 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF ; 0x02 ; 0x05 0x60 Channel number (0 - 21) 0x03 •...
  • Page 27 Wavecard-Waveport User Manual Coronis Systems Format of commands for selecting transmission power • Request (host to Wavecard) REQ_CHANGE_TX_POWER HEADER DATA 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF ; 0x02 ; 0x05 0x44 Parameter value (0x0A, by default) 0x03 •...

  • Page 28: Activating Rssi Threshold Auto-Correction

    Wavecard-Waveport User Manual Coronis Systems 3.3.4 Activating RSSI threshold auto-correction RSSI threshold auto-correction is a feature that enables Wavecard to adjust its reception threshold according to ambient noise. This feature is consistent with other Wavenis power-saving techniques, and is implemented by battery-powered Wavecard modules at reset.

  • Page 29: Selecting The Serial Baud Rate

    Wavecard-Waveport User Manual Coronis Systems • Response (Wavecard to host) RES_READ_AUTOCORR_STATE HEADER DATA 3 bytes 1 byte 1 byte 1 byte 2 bytes 1 byte Status Auto-correction state 0xFF ; 0x02 ; 0x06 0x5B 0x00: Reading OK 0x00 : activated...

  • Page 30: Reading Wavecard Firmware Version

    Wavecard-Waveport User Manual Coronis Systems • Response (WaveCard to host) RES_CHANGE_UART_BDRATE HEADER DATA 3 bytes 1 byte 1 byte 2 bytes 1 byte Status 0xFF ; 0x02 ; 0x43 0x00 : Update OK 0x03 0x05 0x01 : Update error 3.3.6...

  • Page 31: Reading Rssi

    Wavecard-Waveport User Manual Coronis Systems The table below shows available physical layer modes: Physical layer Value 433 MHz frequency hopping 9600 baud 0x00A1 868 MHz single channel 4800 baud 0x0012 868 MHz single channel 4800 baud Alarm Band 0x0094 868MHz single channel 9600 baud with channel selection...

  • Page 32: Rssi Command Format

    Wavecard-Waveport User Manual Coronis Systems Commands NAME DESCRIPTION 0x68 REQ_READ_REMOTE_RSSI Request to read RSSI level from remote module 0x69 RES_READ_REMOTE_RSSI Remote module response to RSSI level request Request to read the Wavecard RSSI level by frame exchange with a 0x6A REQ_READ_LOCAL_RSSI remote module.

  • Page 33: Test Mode

    Wavecard-Waveport User Manual Coronis Systems • Response RES_READ_LOCAL_RSSI HEADER DATA 3 bytes 1 byte 1 byte 2 bytes 1 byte 0xFF ; 0x02 ; Value of RSSI level of the local Wavecard 0x6B 0x03 0x05 upon receiving the frame sent by a remote module Min.

  • Page 34: Service Commands

    Wavecard-Waveport User Manual Coronis Systems 4. SERVICE COMMANDS Services commands are used to configure Wavecard modules or to read radio parameters independently of the connected host equipment. No data is sent to the connected host when a Wavecard recognizes a service command.

  • Page 35: Request Types

    Wavecard-Waveport User Manual Coronis Systems Request types The transmitting module sends a service command that includes a request type. Each request type has an associated response type which is included in the SERVICE_RESPONSE command. In command byte coding, response frames reuse the request command with the LSB bit set to 1.

  • Page 36: Detecting Presence Of Wavecard (Wavenis) Modules

    Wavecard-Waveport User Manual Coronis Systems Detecting presence of Wavecard (Wavenis) modules It may be useful to check the presence and link budget of a remote module before pursuing data exchange operations. The Get_Type Command is sent like a service command, allowing a remote Wavecard to process a response independently of its host equipment.

  • Page 37: Communication Modes

    Wavecard-Waveport User Manual Coronis Systems 5. COMMUNICATION MODES This chapter covers: • The methods for using Wavecard's four communication modes • Command format • Corresponding parameters Frame exchange mode This type of radio exchange allows you to send a request and then wait for a response from remote modules.

  • Page 38: Commands And Formats

    Wavecard-Waveport User Manual Coronis Systems 0: both status and error frames deactivated 1: error frame activated EXCHANGE_STATUS 0x0E Parameter for activating or deactivating 2: status frame activated error or status frame management. 3: both status and error frames activated By default, RECEPT_ERROR_STATUS = 0x00 5.1.2...

  • Page 39: Using Relay Mode

    Wavecard-Waveport User Manual Coronis Systems Defining maximum size • Point to Point mode Max = 152 bytes of data • Relay mode Max = 152 – (2 + 6 x Number of repeaters) => 1 repeater: 144 bytes of data =>...
  • Page 40 Wavecard-Waveport User Manual Coronis Systems Here is the format of these frame types: • Response received by host (RELAY_ROUTE_STATUS deactivated) RECEIVED_FRAME HEADER DATA 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte Data from received frame 0xFF ; 0x02 ;...

  • Page 41: Managing Time-Outs

    Wavecard-Waveport User Manual Coronis Systems • In point-to-point mode RECEPTION_ERROR HEADER DATA 3 bytes 1 byte 1 byte 1 byte 2 bytes 1 byte EXCHANGE_MODE : ERROR_TYPE : = 0x01: point-to-point = 0x01: RF acknowledgement not received 0xFF ; 0x02 ;...
  • Page 42 Wavecard-Waveport User Manual Coronis Systems Point-to-Point exchange: Delta 1: RADIO_USER_TIMEOUT, with RADIO_ACKNOWLEDGE disabled. Delta 2: RADIO_USER_TIMEOUT, with RADIO_ACKNOWLEDGE enabled. Delta 1 = Delta 2 = RADIO_USER_TIMEOUT CS-SUP-MUTI-WPORTAPP-E04...
  • Page 43 Wavecard-Waveport User Manual Coronis Systems Relay mode diagram: When relay mode is used, the time-out (with respect to the transmitter) is not the same as with point-to-point mode because of the additional time it takes to pass through intermediate nodes. The time-out specified by RADIO_USER_TIMEOUT is still applied, but it does not take relays into account.

  • Page 44: Message Mode

    Wavecard-Waveport User Manual Coronis Systems Message mode This type of radio exchange allows you to send requests without waiting for remote modules to respond. After sending a frame the Wavecard board listens on its RS232 serial link. Commands in message mode are mostly used for simple data transfer between several Wavecard modules.
  • Page 45 Wavecard-Waveport User Manual Coronis Systems The formats of frame types received by the host are: • Message mode request REQ_SEND_MESSAGE HEADER DATA 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte n bytes of data to transmit 0xFF ; 0x02 ;...

  • Page 46: Using Relay Mode

    Wavecard-Waveport User Manual Coronis Systems 5.2.3 Using relay mode Relay mode is only available for point-to-point exchanges (frame exchange or message types). Frame transmission To send a request to a remote module using relay mode, you must configure a repeater list with RELAY_ROUTE.
  • Page 47 Wavecard-Waveport User Manual Coronis Systems Here is the format of these frame types: • Response received by host (RELAY_ROUTE_STATUS deactivated) RECEIVED_FRAME HEADER DATA 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte 0xFF ; Data from received frame Radio address of 0x02 ;...
  • 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...
  • Page 49 Wavecard-Waveport User Manual Coronis Systems RECEPTION_ERROR frame format With this command, the local WaveCard informs its host that a problem occurred during the exchange. This command is forwarded between the Wavecard and its host using the serial link, and therefore does not require a recipient's address.

  • Page 50: Polling Mode

    Wavecard-Waveport User Manual Coronis Systems Polling mode Polling mode allows you to send a request to a predefined list of remote modules. Responses are sent to the host that originated the request when all remote modules have responded or after a time-out. The are two...

  • Page 51: Commands And Formats

    Wavecard-Waveport User Manual Coronis Systems 5.3.2 Commands and formats NAME DESCRIPTION Radio board response to frame transmission (response to the 0x21 RES_SEND_FRAME request 0x20, 0x22, 0x24, 0x26, 0x28, 0x2A) 0x26 REQ_SEND_POLLING Request to send a radio frame in polling mode.

  • Page 52: Selective Vs. Non-Selective Polling Mode

    Wavecard-Waveport User Manual Coronis Systems 5.3.3 Selective vs. non-selective polling mode Generally, you need to configure a table containing the addresses of the modules to be queried (POLLING_ROUTE) in polling mode (selective or not-selective). When using selective polling, you need to configure (on the transmitter side) the group number of modules to be queried.
  • Page 53 Wavecard-Waveport User Manual Coronis Systems The procedure to initiate a request in non-selective polling mode is: • Configure a POLLING_ROUTE table containing the addresses of all the modules to be queried (Launch a request to modify internal parameters) • Launch a request in polling mode Principle of selective polling Only the modules belonging to the queried group are synchronized with the transmitter.
  • Page 54 Wavecard-Waveport User Manual Coronis Systems Follow this procedure to initiate a request in selective polling mode: • Configure a POLLING_ROUTE table containing all the addresses of modules to be queried; transmit a request to modify internal parameters. • Configure the group number of each remote module contained in the table (POLLING_ROUTE) ;...

  • Page 55: Diagram Of A Polling Mode Exchange

    Wavecard-Waveport User Manual Coronis Systems 5.3.4 Diagram of a polling mode exchange This diagram shows a typical case where remote Wavecards communicate with their respective hosts. When sending a GET_TYPE request (see chapter 4) in polling mode, remote Wavecards respond without preliminary dialogue with their host.
  • Page 56 Wavecard-Waveport User Manual Coronis Systems For synchronization reasons, even if a remote module responds before the end of the POLLING_TIME time-out, the next request is sent only after the time-out. Low-level commands are used to gather RECEIVED_FRAME_POLLING responses. An index is incremented upon reception of each polling response.

  • Page 57: Broadcast Mode

    Wavecard-Waveport User Manual Coronis Systems Polling mode exchanges do not use the values set in the RADIO_ACKNOWLEDGE parameter. Broadcast mode This mode allows a transmitter to address a request to all Wavenis modules within radio range. You do not have to specify the address of each remote module.

  • Page 58: Using Broadcast Mode (Without Waiting For Response)

    Wavecard-Waveport User Manual Coronis Systems 5.4.2 Using broadcast mode (without waiting for response) This mode allows you to address a request to all Wavenis modules within radio range of the transmitter without waiting for responses. Depending to the EXCHANGE_STATUS settings, the local Wavecard is ready for further RS232 serial link exchanges: •...

  • Page 59: Using Broadcast Mode (Waiting For Responses)

    Wavecard-Waveport User Manual Coronis Systems 5.4.3 Using broadcast mode (waiting for responses) After transmitting a broadcast request, Wavecard switches to reception mode, during which time it will record all responses from remote modules. This phase ends after the time-out set by BCST_RECEPTION_TIMEOUT (0x17).
  • Page 60 Wavecard-Waveport User Manual Coronis Systems Example: broadcast 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 ready for RS232 communication. CS-SUP-MUTI-WPORTAPP-E04...

  • Page 61: Command Format From The Transmitter Side

    Wavecard-Waveport User Manual Coronis Systems 5.4.4 Command format from the transmitter side • Broadcast requests – 0x28 or 0x2A (REQ_SEND_BROADCAST or REQ_SEND_BROADCAST_MESSAGE) REQ_SEND_BROADCAST or REQ_SEND_BROADCAST_MESSAGE HEADER DATA 3 bytes 1 byte 6 bytes variable 2 bytes 1 byte n bytes of data to transmit 0xFF ;...

  • Page 62: Command Format From The Receiver Side

    Wavecard-Waveport User Manual Coronis Systems 5.4.5 Command format from the 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 n bytes of data 0xFF ; 0x02 ;...

  • Page 63: Using Selective And Non-Selective Broadcast Modes

    Wavecard-Waveport User Manual Coronis Systems 5.4.6 Using selective and non-selective broadcast modes There is no specific procedure for initiating a broadcast request in selective or non-selective modes. You just have to make sure that remote modules have their GROUP_NUMBER parameter configured.

  • Page 64: Multi-Frame Mode

    Wavecard-Waveport User Manual Coronis Systems Multi-frame mode From the user's perspective, multi-frame mode is used only for reception. That is, Wavecard they can receive data in multi-frame mode but they cannot transmit. Restrictions for using multi-frame mode: • Wavecard does not currently offer multi-frame mode between two Wavecard/Waveport modules.

  • Page 65: Appendix I - Wavecard Physical Layout

    Wavecard-Waveport User Manual Coronis Systems Appendix I – Wavecard physical layout • 25mW Wavecard CS-SUP-MUTI-WPORTAPP-E04...
  • Page 66 Wavecard-Waveport User Manual Coronis Systems • 500mW Wavecard CS-SUP-MUTI-WPORTAPP-E04...

  • Page 67: Appendix Ii - Wavecard Electronic Interface

    Wavecard-Waveport User Manual Coronis Systems Appendix II – Wavecard electronic interface • 25mW WaveCard PIN # PIN NAME DESCRIPTION INPUT / OUTPUT TX RS232 signal OUTPUT RX RS232 signal INPUT RESET RESET input (active to high level, min.: 100 ms)

  • Page 68: Appendix Iii - Parameter List

    Wavecard-Waveport User Manual Coronis Systems Appendix III – Parameter list Parameter Description Value Size number (bytes) Period in multiples of 100 ms AWAKENING_PERIOD 0x00 (by default, 0x0A for one second) RF radio medium polling period, in multiples of 100 ms...

  • Page 69: Appendix Iv - Parameter Setting Commands

    Wavecard-Waveport User Manual Coronis Systems Appendix IV – Parameter setting commands Name Description 0x40 REQ_WRITE_RADIO_PARAM Request to update radio parameters 0x41 RES_WRITE_RADIO_PARAM Radio board response to radio parameter update 0x42 REQ_CHANGE_UART_BDRATE Request to update serial link baud rate RES_CHANGE_UART_BAUDRA Radio board response to the serial link baud rate update. Serial link baud rate...

  • Page 70: Appendix V - Data Transmission Commands

    Wavecard-Waveport User Manual Coronis Systems Appendix V – Data transmission commands NAME DESCRIPTION 0x20 REQ_SEND_FRAME Request to send a radio frame and to wait for the radio response. Radio board response to the frame transmission (response to 0x20, 0x21 RES_SEND_FRAME...

This manual is also suitable for:

Wavenis waveport

Table of Contents