Repository navigation
tedge-dot 0.0.14
tedge-dot ships as two interchangeable packages, each containing the same
/usr/bin/tedge-dot binary, the same systemd unit and the same
/etc/tedge/plugins/ot/ config layout. They speak the same
OT Connector Contract,
so a config, a flow or a cloud integration built against one works unchanged against
the other. Install one or the other — they declare each other as conflicting.
| Package | Implementation | Pick it when |
|---|---|---|
tedge-dot-rs |
Rust (impl/rust/) |
Default. Richest protocol support, one static binary, no shared-library dependencies. |
tedge-dot-c |
C (impl/c/) |
Small or old devices: ~25x smaller, a glibc 2.17 floor (Debian 8 / RHEL 7 era), and it additionally ships the PROFIBUS-DP connector. |
Install
Both packages are published to the thin-edge.io community repository, which
also carries their tedge-parameter-plugin dependency (it maps the Cumulocity
Parameters tab onto point writes). With that repository set up
(instructions):
# Debian / Ubuntu
sudo apt-get install -y tedge-dot-rs # or tedge-dot-c
sudo systemctl status tedge-dot
# RPM distros
sudo dnf install tedge-dot-rs # or tedge-dot-cOr download the package for your architecture from the assets below. The
package manager still resolves tedge-parameter-plugin from the community
repository, so set that up first:
sudo apt-get install -y ./tedge-dot-rs_*_linux_amd64.deb # or ./tedge-dot-c_*_amd64.deb
sudo dnf install ./tedge-dot-rs_*_linux_amd64.rpm # or ./tedge-dot-c_*_amd64.rpmAlpine: the attached
.apkfiles carry a version string apk-tools rejects
(apk version -crefuses both this project's tag format and the snapshot
form), soapk addwill not install them. Use the tarball on Alpine until
that is fixed — see TODO.md.
Or grab a tarball and run the binary directly — it doubles as a one-shot
read/write CLI. The tedge-dot-c tarball carries the default configs to start from:
./tedge-dot read -c config-defaults/modbus.toml --jsonSHA256SUMS covers every asset in this release.
Upgrading from a release before the split
The package formerly called tedge-dot is now tedge-dot-rs. Both packages
Replaces: the old name, so installing either over an existing tedge-dot
works and keeps your /etc/tedge/plugins/ot/ configuration:
sudo apt-get install -y ./tedge-dot-rs_*_linux_amd64.debTwo caveats:
apt install tedge-dotno longer resolves —tedge-dotis now a virtual
package provided by both, so apt cannot choose. Install by the real name.
Scripts and runbooks using the old name need updating.- A plain
apt upgradewill not migrate an existingtedge-dotinstall; it
stays on the old package name and receives no further updates until you
install one of the new ones explicitly.
Report by exception (report)
A point, a device or [connector] can now declare a reporting policy, applied by the
connector itself for every protocol before a sample is published: on_change, deadband
(absolute, or a percentage such as "2%"), min_interval (a change held back is published
when the interval ends), max_interval (a heartbeat that publishes a fresh reading of a flat
signal, reading a subscribed OPC UA node on demand) and debounce. See
doc/reducing-data-volume.md.
- The packaged Modbus, OPC UA, CANopen and PROFIBUS configs set
[connector] report = { max_interval = "30m" }, so a device whose values never change stays
available in Cumulocity. This applies to fresh installs only: an existing
/etc/tedge/plugins/ot/*.tomlis kept on upgrade. To opt in, add that line to its
[connector]section and reload the service. Without areportanywhere, every reading is
published as before. - The
ot-measurementflow'son_change,deadband,min_intervalanddebouncesettings,
and the same keys in a point'smeta, are deprecated. They keep working; move them to
the point'sreporttable, and do not use both. tedge-dot-c, CAN bus: a signal is now published once per received frame, as in
tedge-dot-rs, instead of republishing the last frame on every poll.
Value mapping (map)
A point can now declare a value map, which the connector applies in both directions for
every protocol. It maps state codes to labels, using exact values, lists or inclusive ranges
with a catch-all default, and it converts with as = "number" | "string" | "bool", so numeric
text becomes a measurement. Samples carry the mapped value and add the original as
source_value.
Writes carry the mapped value as well, and the connector maps it back to the device's code. This
covers the write and write-batch commands, the CLI and Cumulocity device parameters, where
tedge-dot describe offers a mapped parameter's labels as a choice. See
doc/mapping-values.md.
- A point without
mapis unchanged. - The demo point libraries show the feature: the Modbus
boiler_statemaps by range, and the
OPC UArun_stateis an enumerated parameter.
Literal device parameters (meta.parameter.fragment)
A device parameter no longer has to sit inside an object. With
meta.parameter = { fragment = "pump_speed" } the point's value is published as the fragment
itself, so the managed object holds "pump_speed": 42 rather than an object around one value.
tedge-dot describe renders it as a primitive Cumulocity definition (number, boolean or string),
and an edit from the Parameters tab carrying the bare value is written to the point.
- The name is used verbatim, like
set. It cannot be combined withset,grouporkey, and
one name cannot be both a literal and a set.describerefuses either. - Configurations without
fragmentare unchanged.
OPC UA structured values (tedge-dot-rs only)
The OPC UA connector reads custom data types (structures) from any server without compiled-in
type definitions. Give a point address.field ("Speed", "Motor.Current",
"Items[1].Value"): the connector reads the type's DataTypeDefinition from the server once per
session and publishes that field as an ordinary sample, so map, report and every flow apply.
Several fields of one node share one read. Also new:
address.indexselects one element of an array variable.- A
mode = "raw"point on a structure publishes its encoded body, with the type named in
addr, for a flow to decode (servers that do not describe their types). - DateTime, LocalizedText, StatusCode, Guid, NodeId, QualifiedName and ByteString values can be
read; the point'sdatatypepicks the form, e.g. DateTime as RFC 3339 text or Unix ms.
Field and element points are read-only. A point without field or index is unchanged, except
that a raw point on a structure now publishes good samples where it published bad ones. The C
package does not support this yet. See doc/connectors/opcua-connector-spec.md §3.7 and the
demo-sim-structures point library.
Measurement units reach Cumulocity
A point's unit now arrives in Cumulocity with every measurement ({"value": 6.6, "unit": "l/m"})
on thin-edge.io 2.x. ot-measurement publishes the units as retained measurement metadata on
te/<device>/m/<type>/meta, which the c8y mapper adds to the measurement. The measurement body is
unchanged, so mappers without that support behave as before.
- The metadata is published only when a unit appears, changes or goes away, one message per
measurement type. It survives a mapper restart. - If you published unit metadata by hand as a workaround, remove that: the flow now owns these
topics. - The first measurement after a unit appears can still go without it.
Config changes are applied on their own
The service now notices when its config files, or the point libraries they reference, change.
It applies the change within a few seconds, with no systemctl reload needed, whether the file
was written by thin-edge.io configuration management, a provisioning tool or an editor.
- It runs the same reload as SIGHUP, which keeps working: unchanged connectors keep running, a
changed one applies its file in place, and an invalid file is logged and ignored. - A file is read only once it has stopped changing. A save that lands while a reload runs gets a
reload of its own. TEDGE_DOT_CONFIG_WATCH_INTERVALsets how often the files are checked (default2s).- To reload only on SIGHUP as before, run
tedge-dot run --no-watch, for example in a systemd
drop-in (see the comments in the unit file), or set the variable to0. - Workarounds that send SIGHUP after a configuration update can be removed.
- The C package now starts with an empty config directory as the Rust one does, and waits for a
config to appear.
Notes
- On a fresh install the service starts with no devices configured. Add
[[device]]sections under/etc/tedge/plugins/ot/, or copy a demo config
from/usr/share/tedge-dot/demo/, then restart the service. - The connector is a dumb driver: the device-side flows that map its
envelopes onto the thin-edge data model are deployed active into
/etc/tedge/mappers/c8y/flows/, with the opt-in alarm/event flows in
/usr/share/tedge-dot/flows/. Seeflows/README.md. tedge-dot-cruntime dependencies (Debian/Ubuntu names):libmodbus5,
libmosquitto1,libcjson1; open62541 is statically linked. It is
cross-compiled with zig against the glibc 2.17 floor.tedge-dot-rsomits the PROFIBUS connector: its serial dependency has a
native libudev build script that does not cross-compile. Build from source on
Linux withcargo build --manifest-path impl/rust/Cargo.toml --features profibus, or usetedge-dot-c.- Where the two implementations differ in behaviour, see the parity table in
impl/c/README.md. - On Alpine, the two packages are not mutually exclusive by metadata: apk
expresses conflicts differently and theconflictsfield is not carried into
the.apk. Installing one over the other will collide on
/usr/bin/tedge-dot— remove the first withapk delbefore installing the
second, rather than forcing the overwrite.