Configuration tools


Editor tools

For the best experience, we recommend to use one of the configuration editors below[1].

Simple config editor (offline/online)

The ‘simple editor’ lets you load and edit your Configuration File[2]:

Online editor Offline editor

Over-the-air editor tools

With a CANedge2, you can perform updates over-the-air by changing the device Configuration File on your server. This can be done e.g. within CANcloud or via the OTA batch manager.


Using the config editor

Below we provide details on how to use the config editor.

Documentation

We strongly recommend that you review the Configuration section of the CANedge docs. This explains how the JSON Schema concept works incl. the role of the Configuration File, Rule Schema and UIschema. Further, it provides detailed examples for some of the more advanced configuration settings like CAN ID filters.

Presentation mode - simple vs. advanced

The editor tools will by default hide advanced settings for simplicity. To show all the available settings, you can switch the Presentation Mode in the sidebar.

Support tools

The editors add a number of configuration tools in the bottom toolbar:

  • Encryption tool: This tool helps you encrypt passwords. For details see the CANedge Docs and the encryption tool section. For batch encryption, see the OTA batch manager section
  • Filter checker: When setting up CAN ID filters, this tool can help evaluate if a given CAN ID will pass through the filter or not. It also provides guidance for setting up J1939 PGN filters
  • Partial config loader: This lets you load, schema-validate and merge a partial Configuration File (e.g. a transmit list) into your active Configuration File
  • Bit timing calculator: You can use the “Bit-timing (advanced)” mode to set a custom bit rate for your application and this calculator can be useful in checking your settings
  • Schema & config loader: This will be open by default when using the editor and lets you load the UIschema, Rule Schema and Configuration File for use in configuration of the device

New major/minor Firmware

If you need to update to a new major/minor CANedge Firmware (e.g. from 00.07.04 to 01.02.04), you will need to add a matching Configuration File to the device SD card. You can use the config editor to help update an existing Configuration File to a new Firmware structure:

  1. Download the new Firmware zip from the CANedge docs
  2. Load the new Rule Schema via the editor sidebar Rule Schema dropdown
  3. Load your old Configuration File via the editor sidebar Configuration File dropdown
  4. Perform updates if needed to ensure validity with the new Rule Schema
  5. Review and download your new Configuration File

For details on how to update the Firmware, see the CANedge docs.


Encryption tool


The CANedge supports encryption of passwords - see the CANedge Docs for details.

Below we outline how to easily encrypt fields using the encryption tool within the config editor.


Generating keys & encrypting plain text data

Within the config editor, click the “Encryption tool” (lock icon) to open the tool.

In the tool, paste the public key (kpub) value from your device.json file and click “Create keys”[3].

This produces two keys:

  1. Server public key: Should be added in the security section of the device Configuration File
  2. Encryption key: Used for the encryption of plain text data (e.g. passwords)

You are now able to encrypt plain text data as follows:

  1. Enter a plain text password and click “Encrypt”
  2. Copy the encrypted password to the relevant field in the Configuration File
  3. Set the corresponding key format to “Encrypted” in the Configuration File

Re-using an encryption key

You can securely store the encryption key for later use. This lets you use the second mode of the encryption tool to encrypt fields using an existing key.

This way you can later update/add passwords without changing the server public key or any pre-encrypted data in your Configuration File.

Warning

If you use multiple WiFi access points, their passwords must be consistently plain or encrypted

Note

If you need to encrypt passwords on a large number of CANedge2 devices, we recommend using the OTA batch manager tool


[1]The Configuration File is a JSON text file. This means you can in principle perform updates via any standard text editor. However, in doing so you will not benefit from the Rule Schema, which ensures that you perform valid edits. For most purposes, we therefore recommend to use a Schema based editor tool.
[2]The CANedge browser tools like the configuration editors (online/offline) work on modern browser like Chrome, Firefox and Internet Edge, but not Internet Explorer.
[3]You can extract the kpub from the device.json file on the device SD card