CSS CANedge2 Manual
  1. Manuals
  2. Brands
  3. CSS Manuals
  4. Data Loggers
  5. CANedge2
  6. Manual

CSS CANedge2 Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
CANedge2 Docs
Release FW 01.04.02
Mar 31, 2021

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Summary of Contents for CSS CANedge2

  • Page 1 CANedge2 Docs Release FW 01.04.02 Mar 31, 2021...

  • Page 3: Table Of Contents

    CONTENTS CANedge2 documentation ........0.1.1 About this manual .

  • Page 5: Canedge2 Documentation

    CANedge2 Docs, Release FW 01.04.02 0.1 CANedge2 documentation 0.1.1 About this manual 0.1.1.1 Purpose This manual describes the functionality of the CANedge2 (firmware 01.04.02) with focus on: 1. Hardware & installation 2. Configuration 3. Firmware upgrade 4. Remote access This manual does not provide details on available software/API tools.

  • Page 6: Legal Information

    CANedge2 Docs, Release FW 01.04.02 0.1.2 Legal information 0.1.2.1 Usage warning Warning: Carefully review the below usage warning before installing the product The use of the CANedge device must be done with caution and an understanding of the risks involved.
  • Page 7 CANedge2 Docs, Release FW 01.04.02 0.1.2.4 Voltage transient tests The CANedge has passed below ISO 7637-2:2011 tests, performed by TÜV SÜD: ISO 7637-2:2011: Voltage transient emissions test on supply lines ISO 7637-2:2011: Transient immunity test on supply lines 0.1.2.5 Contact details...

  • Page 8: Specification

    CANedge2 Docs, Release FW 01.04.02 0.2 Specification 0.2.1 CAN-bus (x2) • Physical – Two physical CAN-bus interfaces – Industry standard DB9 (D-sub9) connectors • Transceiver – Compliant with CAN Protocol Version 2.0 Part A, B and ISO 11898-1 – Compliant with ISO CAN FD and Bosch CAN FD –...

  • Page 9: Logging

    CANedge2 Docs, Release FW 01.04.02 • Controller – Support for both publisher and subscriber modes – Automatic and custom frame lengths – Classic and Extended checksum formats – Configurable transmit messages, single shot or periodic 0.2.3 Logging • Extractable industry grade micro SD-card (8-32GB) •...

  • Page 10: Mechanical

    CANedge2 Docs, Release FW 01.04.02 0.2.6 Mechanical • Status indicated using external LEDs • Robust aluminum enclosure • Dimensions: 50.2 x 83.4 x 24.5 mm (L x W x H) • Weight: 100g • Operating temperature: -25 degC to +70 degC 0.2.7 Connectivity...

  • Page 11: Hardware

    CANedge2 Docs, Release FW 01.04.02 0.3 Hardware 0.3.1 Installation This section outlines the installation requirements that shall be satisfied. 0.3.1.1 Supply quality The nominal voltage shall be kept within specifications at all times. The device is internally protected against low energy voltage events which can be expected as a result of supply wire noise, ESD and stub-wire inductance.

  • Page 12: Connector

    CANedge2 Docs, Release FW 01.04.02 Warning: Opening the enclosure can permanently damage the device due to e.g. ESD (electrostatic discharge) - and improper handling may void the warranty 0.3.1.7 Mounting The device should be mounted in a way that minimizes vibration exposure and accounts for the IP rating of the device.
  • Page 13 CANedge2 Docs, Release FW 01.04.02 Hardware revision 00.01 Pin # Channel 1 (CH1) Channel 2 (CH2) 5V Supply Output CAN 1 L CAN 2 L LIN Data 1 LIN Data 2 GND (optional) GND (optional) CAN 1 H CAN 2 H Supply &...

  • Page 14: Enclosure

    CANedge2 Docs, Release FW 01.04.02 LIN VBAT The LIN-bus positive reference. Supports systems operating from 4V to 24V. • LIN1 VBAT: Pin is shared with device supply and shares the supply input protection circuit • LIN2 VBAT: Tolerates voltage spikes up to 48V. Spikes above this can damage the interface LIN Data LIN-bus single-wire data line referenced to LIN VBAT.
  • Page 15 CANedge2 Docs, Release FW 01.04.02 (continued from previous page) LOG/ [DEVICE_ID] 00000001 00000001.MF4 00000002.MF4 00000002 00000001.MF4 00000002.MF4 • config-XX.XX.json: Configuration File (device configuration) • schema-XX.XX.json: Rule Schema (configuration rules) • device.json: Device File (device information) • LOG/: Path for log files For more information on the specific files, refer to the documentation menu.

  • Page 16: Led

    CANedge2 Docs, Release FW 01.04.02 Size [GB] Lifetime @ 1MB/sec [years] Lifetime @ 1MB/min [years] 47.9 191.5 0.3.5 LED 0.3.5.1 Location The LEDs are located at the back of the device as illustrated below. 0.3.5.2 Overview LED Short Name LED Color...

  • Page 17: Label

    CANedge2 Docs, Release FW 01.04.02 The WiFi LED is on when the device is connected to a WiFi access point. Note: The device only connects to WiFi when a transfer is pending and is otherwise disconnected (LED off) 0.3.6 Label A unique label is attached to the back of each device.

  • Page 18: Configuration

    CANedge2 Docs, Release FW 01.04.02 0.4 Configuration 0.4.1 General This page documents the general configuration. 0.4.1.1 Configuration file fields This section is autogenerated from the Rule Schema. Device device Meta data device.properties.meta Optional meta data string. Displayed in device file and log file headers. Example: Site1; Truck4; Confi-...
  • Page 19 CANedge2 Docs, Release FW 01.04.02 Security Some configuration field values can be encrypted to hide sensitive data stored in the Configuration File (passwords etc.). In this section, we provide a technical summary and provide resource suggestions for implementing the encryption.

  • Page 20: Logging

    CANedge2 Docs, Release FW 01.04.02 5. Derive shared symmetric key using HMAC-SHA256 with “config” as data and shared secret as key. Use the first 16 bytes of the output 6. Encode user public key (used by the device to calculate the same shared symmetric key for decryp- tion) 7.
  • Page 21 CANedge2 Docs, Release FW 01.04.02 File split time period (0 to 86400 seconds, 0 = disable) file.properties.split_time_period Log file split time period in seconds relative to midnight (00:00:00). When a split time is reached a new file is created and the logging continues. Closed log files can be pushed to a server if WiFi is available.
  • Page 22 10 MB, the resulting file sizes become 10 MB regardless if compression is used or not. If files are offloaded through WiFi in the case of the CANedge2, the logging will resume Compressed size in percentage of original. Lower is better.

  • Page 23: Real-Time-Clock

    CANedge2 Docs, Release FW 01.04.02 Encryption Log files can be encrypted on the device. Here, data is streamed through an AES-GCM encryption scheme prior to persistence on the SD card. Encrypted files have *.MFE as file extension. Note: It is recommended to use a 40+ character password for proper encryption Decryption can be done using an implementation of the PBKDF2 algorithm or via CANedge tools (see the CANedge Intro).

  • Page 24: Secondary Port

    7. Set timezone (timezone) and do minor adjustments (adjustment) if needed Automatic update The CANedge2 supports auto RTC synchronization via WiFi (enabled by default). In this mode, the device retains the current time - but periodically synchronizes the RTC against an NTP server.

  • Page 25: Can

    CANedge2 Docs, Release FW 01.04.02 To power_schedule.items.properties.to Power-on TO time in format HH:MM. Shall be after power-on FROM time. E.g. at midday 12:00. type: string default: 00:00 0.4.4.2 Configuration explained This section contains additional information and examples. Note: Power out scheduling has resolution of 1 min and 1 min tolerance...
  • Page 26 CANedge2 Docs, Release FW 01.04.02 Reception (rx) initial state properties.rx_state The initial state of CAN-bus reception. Can be changed using the control signal. type: integer default: 1 options: Disable: [0] Enable: [1] Transmission (tx) initial state properties.tx_state The initial state of CAN-bus transmissions. Can be changed using the control signal.
  • Page 27 CANedge2 Docs, Release FW 01.04.02 Bit-rate configuration mode bit_rate_cfg_mode Configures how the CAN bus bit-rate is set. Modes Auto-detect and Bit-rate support all standard bit-rates. Non-standard bit-rate configuration can be set using Bit-timing. It is recommended to set the bit-rate manually if it is known.
  • Page 28 CANedge2 Docs, Release FW 01.04.02 ������/������ • Bit-rate: ���� = �� 1+������ • Sample point: ���� = 100 �� Example: Matching bit-timing settings based on different input clock frequency (CLK). Settings to match (based on a 80MHz input clock): • Bit-rate: 2M •...
  • Page 29 CANedge2 Docs, Release FW 01.04.02 ID filters properties.id Filters are checked sequentially, execution stops with the first matching filter element. Max 128 11-bit filters and 64 29-bit filters. type: array minItems: 1 maxItems: 192 Name properties.id.items.properties.name Optional filter name. type: string maxLength: 16 State properties.id.items.properties.state...
  • Page 30 CANedge2 Docs, Release FW 01.04.02 To (range) / mask (mask) (HEX) properties.id.items.properties.f2 If filter method is Range, this field defines the end of range. If filter method is Mask, this field defines the filter mask. type: string maxLength: 8 default: 7FF Configuration explained This section contains additional information and examples.
  • Page 31 CANedge2 Docs, Release FW 01.04.02 Example: A message matches rejection filter 2. The following filters are not evaluated. The message is rejected. Example: A message does not match any filters. The message is rejected. Filter method Acceptance and Rejection filters can be defined by range or mask. In either case, both the message type (standard / extended) and ID are compared to the filter.
  • Page 32 CANedge2 Docs, Release FW 01.04.02 Example: Filter configuration which accepts two message IDs: • 2000 = 11111010000 • 2001 = 11111010001 Note that the two binary numbers are identical except for the rightmost bit. To design a filter which accepts both IDs, we can use the mask field to mask out the rightmost bit - such that it is not considered when the filter is applied.
  • Page 33 CANedge2 Docs, Release FW 01.04.02 • Filter from: 500 • Filter to: 1000 The filter list is constructed with the rejection filter first, followed by the acceptance filter. Note that messages are first processed by the rejection filter (rejects all odd messages), then proccessed by the acceptance filter (accepts all message in range).
  • Page 34 CANedge2 Docs, Release FW 01.04.02 ID (DEC) ID occurrences Result Accept Reject Reject Accept Reject Time Time prescaling sets a lower limit on time interval (period time) of a specific message ID. This is done by rejecting messages until at least the prescaler time has elapsed .
  • Page 35 CANedge2 Docs, Release FW 01.04.02 Data Data prescaling can be used to only accept messages when the data payload changes. A mask can be set to only consider changes in one or more specific data bytes. The mask works on a byte level. The mask is entered in hex up to 8 bytes long (16 hex characters).
  • Page 36 CANedge2 Docs, Release FW 01.04.02 with mask 1 (considering only changes to the 1st data Example: Data prescaling applied to ID 800 byte). D0-D3 is a 4-byte payload (with D0 the first data byte). ID (DEC) Result Accept Reject Reject...
  • Page 37 CANedge2 Docs, Release FW 01.04.02 type: string maxLength: 16 State items.properties.state Disabled transmit messages are ignored. type: integer default: 1 options: Disable: [0] Enable: [1] ID Format items.properties.id_format ID format of the transmit message. [{ type : integer , title :...
  • Page 38 CANedge2 Docs, Release FW 01.04.02 Message ID (hex) items.properties.id ID of message to transmit in hex. Example: 1FF. type: string Messages Data (hex) items.properties.data Data bytes of message to transmit. RTR frames only use the number of bytes do determine the DLC.
  • Page 39 CANedge2 Docs, Release FW 01.04.02 Configuration explained This section contains additional information and examples. Note: The heartbeat cannot be disabled using the control signal Note: The heartbeat feature requires a CAN-bus physical mode supporting transmissions Payload format The device can transmit a 1-second periodic heartbeat signal. The signal payload contains logging state (enabled/disabled), the device time and space left on the memory card in MB.
  • Page 40 CANedge2 Docs, Release FW 01.04.02 0.4.5.6 Control This page documents the control configuration Configuration file fields This section is autogenerated from the Rule Schema file. Control ‘‘ ‘‘ Control signal Control reception (rx) state properties.control_rx_state Control CAN-bus reception state (including logging)
  • Page 41 CANedge2 Docs, Release FW 01.04.02 Message ID mask (hex) properties.id_mask ID mask of the control message in hex. Example: 1FFFFFFF. type: string default: 1FFFFFFF Data mask (hex) properties.data_mask Data trigger mask (byte 0 to the left). Shall match the length of the control signal message.
  • Page 42 CANedge2 Docs, Release FW 01.04.02 Warning: The start/stop ranges shall be mutual exclusive (cannot both occur at the same time) Examples Example: Start / stop on OBD speed response message. The OBD CAN-bus is connected to two CAN-bus channels. Channel 1 is configured to start / stop message reception based on the OBD speed response.
  • Page 43 CANedge2 Docs, Release FW 01.04.02 Example: Start / stop on simple discrete value. In this example the start / stop is controlled via a single byte. Start trigger: • High: 01 • Low: 01 Stop trigger: • High: 00 • Low: 00 "start": {...

  • Page 44: Lin

    CANedge2 Docs, Release FW 01.04.02 • Low: 0000000000000000 0 km/h "control": { "start": { "id_format": 1, "id": "CFEF100", "id_mask": "3FFFF00", "data_mask": "0000FF0000000000", "data_high": "0000070000000000", "data_low": "0000030000000000" "stop": { "id_format": 1, "id": "CFEF100", "id_mask": "3FFFF00", "data_mask": "0000FF0000000000", "data_high": "0000010000000000", "data_low": "0000000000000000"...
  • Page 45 CANedge2 Docs, Release FW 01.04.02 Mode mode Device LIN bus mode. type: integer default: 0 options: Subscriber: [0] Publisher: [1] Bit-rate bit_rate options: 2400: [2400] 9600: [9600] 10400: [10400] 19200: type: default: integer 19200 [19200] Configuration explained This section contains additional information and examples.
  • Page 46 CANedge2 Docs, Release FW 01.04.02 Configuration explained This section contains additional information and examples. The LIN controller expects default data lengths and checksums as explained in . LIN-frames using a different configuration (length, checksum or both) can be explicitly configured using the frame table.
  • Page 47 CANedge2 Docs, Release FW 01.04.02 Length of data is zero The transmit is a SUBSCRIBE frame, meaning that a Subscriber on the bus is expected to provide the data payload (satisfying the frame table). Length of data is above zero The transmit is a PUBLISH frame, meaning that the CANedge provides the data payload.

  • Page 48: Connect

    CANedge2 Docs, Release FW 01.04.02 0.4.6.6 Checksum Supports LIN 1.3 classic checksum and LIN 2.0 enhanced checksum format. By default, all frames except ID 0x3C and 0x3D will use enhanced checksum. This can be overridden in the configuration for each frame ID.
  • Page 49 CANedge2 Docs, Release FW 01.04.02 Configuration file fields This section is autogenerated from the Rule Schema file. Error: Unable to execute python code at s3.rst:17: ‘NoneType’ object is not iterable Configuration explained This section contains additional information and examples. Request-style S3 supports two different request styles path and virtual hosted.

  • Page 50: Device File

    Additional content may be added to the device.json in future firmware updates. Fields explained • id: Device unique ID number • type: Device type (CANedge1 = 0000001D, CANedge2 = 0000001F) • kpub: Device public key in Base-64 format • fw_ver: Firmware version •...

  • Page 51: Log File

    CANedge2 Docs, Release FW 01.04.02 0.6 Log file This page documents the log files stored on the device SD-card. 0.6.1 Organization Log files are organized by the following path structure: LOG/[DEVICE_ID]/[SESSION_NUMBER]/[SPLIT_NUMBER].[FILE_EXTENSION] The path is constructed from the following parts: • LOG: Static directory name used to store log files •...
  • Page 52 CANedge2 Docs, Release FW 01.04.02 Timestamps Each record is timestamped with 50 us resolution Finalization & sorting The CANedge stores log files as unfinalized and unsorted to enable power safety. Finalization sorting can be done as a post-processing step to speed up work with the files.

  • Page 53: Remote Access

    CANedge2 Docs, Release FW 01.04.02 0.7 Remote access 0.7.1 Network The CANedge supports wireless connectivity over WiFi. The WiFi specifications are given here. 0.7.1.1 WiFi The CANedge is able to connect to a WiFi access point (AP). The CANedge expects to be assigned an IP by a DHCP service running on the access point. The network application name (host name) of a connected CANedge is the unique device ID.
  • Page 54 CANedge2 Docs, Release FW 01.04.02 Table of Contents • Server – Server types ∗ Local ∗ Dedicated ∗ Cloud – Transfer throughput 0.7.2.1 Server types In the below we briefly outline the main server types. Local An S3 compatible server can easily be installed on any regular office PC.

  • Page 55: Managing Devices

    CANedge2 Docs, Release FW 01.04.02 If multiple servers are available (such as regional cloud server endpoints), make sure to select a server with low device-to-server latency. 0.7.3 Managing devices This section covers how the CANedge interfaces to an S3 server and how to manage devices: 0.7.3.1 Buckets...
  • Page 56 CANedge2 Docs, Release FW 01.04.02 Meta data S3 allows additional meta data to be attached to each file. The device adds below S3 meta data: • X-Amz-Meta-Hw: The device hardware revision • X-Amz-Meta-Fw: The device firmware revision • X-Amz-Meta-Ssid: The WiFi SSID which was used to upload the file/object •...
  • Page 57 CANedge2 Docs, Release FW 01.04.02 FOTA sequence with same MAJOR/MINOR version (example: 01.02.03 to 01.02.04) 1. The firmware.bin Firmware File is placed in [BUCKET NAME]/[DEVICE ID]/firmware.bin 2. The device downloads the Firmware File and reboots 3. The device continues to use the same Configuration File FOTA sequence with new MAJOR/MINOR version (example: 01.02.03 to 01.03.00)

  • Page 58: Security

    CANedge2 Docs, Release FW 01.04.02 4. Generate a new Server Certificate Bundle without the soon-to-expire certificate and repeat step 2 and 3. Warning: Above sequence assumes that both certificates are valid during the process. Change to another S3 endpoint 1. Generate a Server Certificate Bundle (certs_server.p7b) with the current and new certificate(s) 2.
  • Page 59 CANedge2 Docs, Release FW 01.04.02 API credentials The device uses the server S3 credentials (AccessKey and SecretKey) to calculate an authentication signature for each request. Upon reception, the server verifies the signature (see the S3 REST API for details). Only devices with a valid AccessKey and SecretKey pair can gain access to the S3 storage.
  • Page 60 CANedge2 Docs, Release FW 01.04.02 Server identity authentication HTTPS (TLS) is used to authenticate the server certificate. This ensures that devices only allow con- nections to trusted servers. Server certificate authentication sequence: Installation requirements Same as Low Security Mode. Additionally, devices are pre-loaded with the CA certificate used to issue the server certificate - see the installation details further below.
  • Page 61 CANedge2 Docs, Release FW 01.04.02 TLS uses a chain of certificates for establishing trust. At the top of the chain is the root certificate authority (CA). At the buttom is the user (application) certificate. In this specific case, the user certificate is used to identify either the server or the client (device).
  • Page 62 CANedge2 Docs, Release FW 01.04.02 Zero certificates (Clear) Clear all loaded certificates by creating an empty/blank file called certs_server.p7b One certificate (Rename) Prepare a single certificate by renaming: 1. Acquire the trusted certificate (e.g. the root certificate) in a supported format (.pem, .cer, .crt, .der)
  • Page 63 CANedge2 Docs, Release FW 01.04.02 certificate_2 etc. If more than 2 certificates are to be stored, insert additional -certfile certificate_n clauses Local installation of certificate(s) The certificate bundle can be installed on the device by placing it in the root of the SD-card.

  • Page 64: Firmware

    CANedge2 Docs, Release FW 01.04.02 0.8 Firmware 0.8.1 Firmware download See the online documentation for the latest Firmware Files and changelog. 0.8.1.1 Mandatory update steps Some upgrade steps are mandatory and cannot be skipped. Skipping mandatory update steps can result in unexpected behavior.

  • Page 65: Firmware Upgrade

    The CANedge2 upgrades the WiFi related features as a second step of the firmware upgrade process after the main firmware has started. Allow the CANedge2 a few minutes to complete the second step of the firmware upgrade. If power is lost during the second step, the device will resume next time it powers on.
  • Page 66 CANedge2 Docs, Release FW 01.04.02 Note: The firmware can be upgraded without providing a new compatible Configuration File. In this case, the device will create a default Configuration File on the SD card 0.8.3.3 Upgrade from SD card The firmware can be upgraded by placing a Firmware File on the SD and powering the device: 1.

This manual is also suitable for:

Canedge1

Table of Contents

Save PDF