HOST Insight Client

This application implements a gRPC client with interrupt-driven async monitors for reading events on digital-in and/or CAN frames on a GNU/Linux system and then transmitting them securely (TLS) to a gRPC server. CAN frames are decoded using a DBC file and sent in a human-readable format.

In addition, the following data is sent:

• heartbeat containing a status code (at some regular interval)
• current state containing sofware version and md5sum hashes of config and DBC file, if any (once after start)

All requests include the client ID in the header.

The following responses can be handled:

• Carry on: continue listening for new data
• Control request: opens a remote control session in which the server can set digital out ports on the client
• Config update: download a new configuration file for the client
• Identity update: receive a unique identity and domain name from deployment server and save it on the device
• Fetch resource: download an arbitrary resource, e.g. a DBC file, to the device
• Software update: download a new version of the client from a predefined location
• Exit: terminate the application with custom exit code

Build requirements:

• Rust v1.59.0 or later
• Protobuf compiler

Host requirements:

• CAN bus and/or digital inputs
• curl
• glibc v2.28 or later
• OpenSSL
• md5sum
• systemd
• host-insight-helper

CAN

The following signal values are supported:

• signed integers
• unsigned integers
• floats including from extended value type list
• strings (enums) from value descriptions

CAN timestamps are not yet implemented. There is experimental support for multiplexed signals.

Digital I/O

Each digital port is given both an internal and an external name. The former is used for finding an existing port on the device and the latter for communicating a function to the server.

Each external port should declare its default state which is automatically set at startup and shutdown. During a remote control session, setting the port as Active means that its non-default state is set.

Example identity

A unique identity and target URL are expected in identity.toml or identity-fallback.toml (in that order) under /etc/opt/host-insight-client/.

uid = "123456"
domain = "example.hostmobility.com"

Example configuration

The application will look for and use conf-new.toml, conf.toml or conf-fallback.toml (in that order) in /etc/opt/host-insight-client/.

Example configuration that enables three Digital In, three Digital Out and two CAN ports:

[digital_in]
ports = [ { internal_name = "digital-in-0", external_name = "Door" },
          { internal_name = "digital-in-1", external_name = "Light" },
          { internal_name = "digital-in-2", external_name = "Finger protection" } ]

[digital_out]
ports = [ { internal_name = "digital-out-source-0", external_name = "Reset", default_state = 0 },
          { internal_name = "digital-out-source-1", external_name = "Up", default_state = 0 },
          { internal_name = "digital-out-source-2", external_name = "Down", default_state = 0 } ]

[can]
ports = [ { name = "can0", bitrate = 125000, listen_only = true  },
          { name = "can1", bitrate = 500000, listen_only = false } ]
dbc_file = "sample.dbc"

[time]
sleep_min_s = 1
sleep_max_s = 3600
heartbeat_s = 30

Building for ARM32 on Debian GNU/Linux

Install build dependencies:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup target add armv7-unknown-linux-gnueabihf
sudo apt install gcc-arm-linux-gnueabihf linux-libc-dev-armhf-cross protobuf-compiler

Use ARMv7 linker:

export CARGO_TARGET_ARMV7_UNKNOWN_LINUX_GNUEABIHF_LINKER=/usr/bin/arm-linux-gnueabihf-gcc

Build:

cargo build --target=armv7-unknown-linux-gnueabihf --release

Copying

HOST Insight Client is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

HOST Insight Client is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA