GridConnect CAN WiFi User Manual
  1. Manuals
  2. Brands
  3. GridConnect Manuals
  4. Control Unit
  5. CAN WiFi
  6. User manual

GridConnect CAN WiFi User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
CAN WiFi
User Guide
Revision F.1 April 17, 2020

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the CAN WiFi and is the answer not in the manual?

Questions and answers

Summary of Contents for GridConnect CAN WiFi

  • Page 1 CAN WiFi User Guide Revision F.1 April 17, 2020...
  • Page 2 Grid Connect and the Grid Connect logo, and combinations thereof are registered trademarks of Grid Connect, Inc. All other product names, company names, logos or other designations mentioned herein are trademarks of their respective owners. CAN WiFi is a trademark of Grid Connect, Inc. Grid Connect 1630 W. Diehl Rd.
  • Page 3 Removed references to CAN-USB232. 05/14/2015 16-bit Time Stamp on received messages 03-02-2016 General updates 08-18-2016 Add new pictures and info for reset button 11-18-2016 Skip count or timeout between consecutive CAN messages received. 04-17-2020 Fixed voltage specs CAN WIFI User Manual...
  • Page 4 The contents of this document shall not become part of or modify any prior or existing agreement, commitment or relationship. CAN WIFI User Manual...

  • Page 5: Table Of Contents

    2.5.10 Set CAN Command Mode TX Output Format.......2-18 2.5.11 Set CAN Command Mode Message Output Termination....2-19 2.6 CAN Virtual Command Mode................2-19 2.6.1 The ‘XMIT’ and ‘RCEV’ Identifiers..........2-20 2.6.2 ‘XMIT’ Identifier................2-20 2.6.3 ‘RCEV’ Identifier................2-20 2.6.4 Get CAN Virtual Circuit Setting............2-21 CAN WIFI User Manual...
  • Page 6 2.14.5 Profile Note All................2-46 2.14.6 Profile Note Text................2-46 2.14.7 Profile Note #=Text................2-46 2.14.8 Set Active Profile to Default............2-47 2.14.9 Set Specific Profile to Default............2-47 2.14.10 Set All Profiles to Default.............2-47 2.15 CAN Sernum in Config Mode................2-47 2.15.1 CAN SERNUM................2-47 CAN WIFI User Manual...
  • Page 7 2.15.3 Get Version Number...............2-47 2.16 Test Options....................2-48 2.16.1 Cycling LED Indicators..............2-48 2.16.2 Generating CAN Square Wave............2-48 2.16.3 Test LEDs..................2-48 2.16.4 Test LEDs and CAN Bus..............2-48 2.16.5 Exit....................2-48 2.17 Technical Support...................2-48 2.17.1 Live Chat..................2-49 2.17.2 Contact Information................2-49 CAN WIFI User Manual...

  • Page 8: Overview

    1. Overview 1.1 Introduction The CAN WIFI module is a hybrid device with two completely separate sub-systems connected internally via a UART interface. One side is the CAN interface with the COM port interface hard-coded to 921,600N81 with RTS/CTS flow control enabled.

  • Page 9: Hardware Description

    1.3 CAN Network Before trying to send commands to the CAN WiFi, make sure the unit is attached to a valid CAN network with at least one other node attached and running. Without another node on the network, the CAN WiFi will attempt to transmit the message indefinitely (as per CAN 2.0A/B specifications).

  • Page 10: Additional Documentation

    Getting Started 1.4 Additional Documentation This manual provides basic information about the CAN WiFi installation and operation. For specific details about configuration and operation, please see the following manuals. The following documents are available on the product CD. Title Description...

  • Page 11: Getting Started

    WiFi configuration to factory defaults. The TX/RX LEDs will start blinking in a circle pattern for about 10 seconds. WARNING: If you press the config button for more than 3 seconds, you will have to re-configure the CAN settings. See the Configuration chapter or the Quick Start for detailed operation. CAN WIFI User Manual...

  • Page 12: Can Driver

    If the device cools sufficiently after thermal shutdown, it will automatically re-enable, and may again rise in temperature if the bus fault is still present. Prolonged operation with thermal shutdown conditions may affect device reliability. BUS LOADING CAN WIFI User Manual...

  • Page 13: Entering Configuration Mode

    Configuration settings for the CAN side are found in this manual. The Quick Start Guide provides information needed to configure the xPico WiFi module for basic tunnel mode operation. Additional xPico WiFi options can be found in the xPico-Wi-Fi_UG.pdf document. CAN WIFI User Manual...

  • Page 14: Config Button

    Getting Started 2.2.1 Config Button Press the Config button (for less than 3 seconds). The config prompt should appear as #0#. Type help or ? to display the prompt messages. CAN WIFI User Manual...

  • Page 15: Mode Options

    2.3 Mode Options 2.3.1 Get Mode In the command mode (CM), the CAN WIFI is capable of sending and receiving arbitrary CAN messages via the use of ASCII formatted message strings. In virtual circuit mode (VC), the CAN WIFI establishes a full-duplex, virtual circuit between itself and another CAN WIFI or application device.

  • Page 16: Can Bus State During Configuration

    2.4.2 CAN Bus State During Configuration While the CAN WIFI is in the configuration mode, the CAN controller is in the bus-off state. It does not interact with the bus and is effectively ‘invisible’. Thus, it is possible to perform configuration of the CAN WIFI while still connected to an active CAN network and not adversely affect network operation.

  • Page 17: Set Can Port Baud Sample Point Tolerance

    Troubleshooting 2.4.5 Set CAN Port Baud Sample Point Tolerance 2.4.6 Set CAN Port Baud Sample Point Browse CAN WIFI User Manual...

  • Page 18: Set Can Port Baud Sample Point Tolerance

    2.4.7 Set CAN Port Baud Sample Point Tolerance 2.4.8 Set CAN Port (CLK_DIV BRG TSEG1 TSEG2 SJW) The ‘TSEG1’ parameter determines the amount of time to wait before the hardware attempts to sample the bit. The value can range from 1 to 16. CAN WIFI User Manual...

  • Page 19: Can Command Mode

    CAN node to adjust its sampling point when it determines that the sample point would be too early or too late. By setting the SJW field to a large number, the CAN WIFI can work with other nodes with a large variation is bus oscillator tolerances.

  • Page 20: Message String Syntax

    Normal CAN Message Syntax : <S | X> <IDENTIFIER> <N> <DATA-0> <DATA-1> … <DATA-7> ; The first character,‘:’, is for synchronization and allows the CAN WiFi parser to detect the beginning of a command string. The following character is either ‘S’ for standard 11-bit, or ‘X’ for extended 29-bit identifier type.

  • Page 21: Rtr Can Message

    2.5.4 Appending CR/LF To Received Command Strings When using the CAN WiFi to view received CAN messages directly on a terminal, the user can set a configuration parameter to append a <CR> <LF> sequence to each message string generated. This makes it easier for the user to see each received message as each message will be on a separate line.

  • Page 22: Binary Formatted Messages

    Getting Started 2.5.5 Binary Formatted Messages The tables below show the format for Binary message format. CAN WIFI User Manual...
  • Page 23 Troubleshooting CAN WIFI User Manual...

  • Page 24: Get Can Command Mode Settings

    Getting Started 2.5.6 Get CAN Command Mode Settings 2.5.7 Set CAN Command Mode Filter On/Off CAN WIFI User Manual...

  • Page 25: Set Can Command Mode Rx Operating Mode

    Troubleshooting 2.5.8 Set CAN Command Mode RX Operating Mode 2.5.9 Set CAN Command Mode RX Input Format 2.5.10 Set CAN Command Mode TX Output Format CAN WIFI User Manual...

  • Page 26: Set Can Command Mode Message Output Termination

    The CAN WiFi only sends CAN messages when eight bytes of data have been received. This leads to a case where the last part of a data stream is not sent if it is less than eight bytes long. To deal with this in a transparent fashion, the CAN WIFI provides a timeout feature that will automatically force a transmission of the last accumulated byte(s) after a specified maximum waiting time.

  • Page 27: The 'Xmit' And 'Rcev' Identifiers

    COM port. The CAN message is then sent over the CAN network. This identifier signals that the CAN message which contains it also contains serial port stream data. Other CAN WIFI units can be configured to look for this identifier and will then extract the stream data from the CAN message.

  • Page 28: Get Can Virtual Circuit Setting

    Getting Started 2.6.4 Get CAN Virtual Circuit Setting CAN WIFI User Manual...

  • Page 29: Set Can Virtual Circuit Tx Id

    Troubleshooting 2.6.5 Set CAN Virtual Circuit TX ID CAN WIFI User Manual...

  • Page 30: Set Can Virtual Circuit Rx Id

    Getting Started 2.6.6 Set CAN Virtual Circuit RX ID CAN WIFI User Manual...

  • Page 31: Set Can Virtual Circuit Forced Send Code

    Troubleshooting 2.6.7 Set CAN Virtual Circuit Forced Send Code CAN WIFI User Manual...

  • Page 32: Set Can Virtual Circuit Forced Wake Code

    Getting Started 2.6.8 Set CAN Virtual Circuit Forced Wake Code CAN WIFI User Manual...

  • Page 33: Set Can Virtual Circuit Timeout Send

    Troubleshooting 2.6.9 Set CAN Virtual Circuit Timeout Send CAN WIFI User Manual...

  • Page 34: Set Can Virtual Circuit Wake Timeout

    Getting Started 2.6.10 Set CAN Virtual Circuit Wake Timeout CAN WIFI User Manual...

  • Page 35: Set Can Virtual Circuit Wait After Wakeup

    Troubleshooting 2.6.11 Set CAN Virtual Circuit Wait after Wakeup CAN WIFI User Manual...

  • Page 36: Set Can Virtual Circuit Wakeup Message

    CONFIG command is enabled, should the config command sequence match one of the force codes, it will be treated as a config command character. To avoid this, either change the force codes or change the config command sequence. CAN WIFI User Manual...

  • Page 37: Defining Filter Entries

    If none of the filters are enabled, it assumes no filtering should be performed and outputs the ASCII message string of the message to the serial port. If any filters are enabled, the CAN WIFI will attempt to match the received message to each enabled filter. At the first successful match, the message is converted to an ASCII message string and output to the serial port.

  • Page 38: Get Can Filter

    Getting Started Once all configuration parameters have been saved and the CAN WIFI enters the normal operating mode, the new filter settings will become active and will be applied to each received CAN message. 2.8.3 Get CAN Filter  The list can be viewed with the ‘get can filter’ command.

  • Page 39: Delete Can Filter

    Either a single entry or and entry range can be specified.  Entries are identified by their index number.  Indexes remaining are re-sorted so there are no gaps. EX-1: del can filter 1 2.8.6 Delete CAN Filter Range CAN WIFI User Manual...

  • Page 40: Delete Can Filter All

    (ie: time or count). This ensures 100% backwards compatibility with applications that do not use the limiter feature. The following command descriptions and examples assume that CAN filters have already been defined as follows: CAN WIFI User Manual...

  • Page 41: Set Can Limiter # C=Count | T=Time

    The value for ‘#’ represents the numeric filter ID as shown in the screenshot above. ‘COUNT’: 1 <= COUNT <= 65535: The skip count. ‘TIME’: 1 <= TIME <= 65535: The minimum amount of time (in ms) between consecutive messages. CAN WIFI User Manual...

  • Page 42: Del Can Limiter # | All

    EXAMPLE #3: DEFINE TWO LIMITERS AT THE SAME TIME FOR FILTER ID # 5 AND # 6 Note: Multiple limiters can be specified in a single command by separating their respective definitions with a space. 2.9.2 Del CAN Limiter # | All The value for ‘#’ represents the numeric filter ID. CAN WIFI User Manual...
  • Page 43 EXAMPLE #4: DELETE LIMITER ON FILTER #0 Note: Multiple limiters can be deleted in a single command by separating their respective IDs with a space. EXAMPLE #5: DELETE ALL DEFINED LIMITERS CAN WIFI User Manual...

  • Page 44: Config Entry Commands

    CM Mode: get cfgcmd cm : Returns the current state of the CM mode config command set cfgcmd cm enabled=yes | no : Enables or disables the command in CM mode (default is enabled) CAN WIFI User Manual...

  • Page 45: Get Cfgcmd Cm

    : " (double quote) : BACKSLASH Ex 1 : "\000" : Binary 0x00 Ex 2 : "\r\n" " CR followed by LF 2.10.1 Get cfgcmd cm 2.10.2 Set cfgcmd cm enable=YES | NO 2.10.3 Get cfgcmd vc CAN WIFI User Manual...

  • Page 46: Set Cfgcmd Vc Enable=Yes | No

    Getting Started 2.10.4 set cfgcmd vc enable=YES | NO 2.10.5 set cfgcmd vc tbeg=timeout 2.10.6 set cfgcmd vc tend=timeout 2.10.7 set cfgcmd vc tid=timeout 2.10.8 set cfgcmd vc seq=”sequence” CAN WIFI User Manual...

  • Page 47: Can Timestamp Commands

    The encoding of the two byte is the same as for the DATA field (i.e., If any of the time-stamp bytes is a synchronization character, it is escaped). The time-stamp field is always two logical bytes, but can be expanded up to four in the case where both MSB and LSB bytes are synchronization characters. CAN WIFI User Manual...

  • Page 48: Get Timestamp

    CAN bus is overloaded or faulty. The command to set/get the timeout follows: get can timeout: Gets the timeout setting. set can timeout can_tx_busy=off: Disables timeout, will wait indefinitely (default) set can timeout can_tx_busy=1000: Sets the timeout (10 to 10000 ms) CAN WIFI User Manual...

  • Page 49: Get Can Timeout

    Troubleshooting 2.12.1 Get can timeout 2.12.2 Set can timeout can_tx_busy=timeout CAN WIFI User Manual...

  • Page 50: Get Sernum In Command Mode

    Three units are configured to have the same RX identifier in RTR mode. Each units as unique TX identifiers. When a node on the network issues a RX identifier request for serial numbers, the three units will all transmit their respective serial number messages. CAN WIFI User Manual...
  • Page 51 Troubleshooting CAN WIFI User Manual...

  • Page 52: Profiles

    Sets the profile note for the current profile to "Text" (default "") profile note #="Text": Sets the specified profile note to "Text" (0 to 9) 2.14.1 Set Active Profile Number 2.14.2 Copy Profile 2.14.3 Profile Note profile note: Returns the note for the currently active profile CAN WIFI User Manual...

  • Page 53: Profile Note

    Returns a list of all profile notes. 2.14.6 Profile Note Text profile note="Text": Sets the profile note for the current profile to "Text" (default "") 2.14.7 Profile Note #=Text profile note #="Text": Sets the specified profile note to "Text" (0 to 9) CAN WIFI User Manual...

  • Page 54: Set Active Profile To Default

    2.15 CAN Sernum in Config Mode 2.15.1 CAN SERNUM The SERNUM command provides a means for the user to query the CAN WIFI for its unique 128-bit serial number. The GET SERNUM command only works while in CONFIG mode and always returns the serial number over the COM port.
  • Page 55 2.16.2 Generating CAN Square Wave The CAN WIFI can generate a square wave output onto the CAN bus arbitrary frequencies. It is useful for measuring propagation delay through cabling with the aid of an oscilloscope and can be used to evaluate bus termination.
  • Page 56 Getting Started 2.17.1 Live Chat Go to the Grid Connect web page at gridconnect.com. Go to the bottom of the page and locate the Support After hours and when a representative is link button. From there you can connect to a live chat session.
  • Page 57 CAN WIFI User Manual...

Table of Contents