Tahu Edge Node / Device

Sparkplug B Edge Node and Device support over MQTT using Eclipse Tahu

Metadata

Property	Value
Scheme	`tahu-edge`
Support Level	Stable
Labels	messaging,iot,monitoring
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-tahu</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`groupId`	string	✓		ID of the group
`edgeNode`	string	✓		ID of the edge node
`deviceId`	string			ID of this edge node device
`checkClientIdLength`	boolean		`false`	MQTT client ID length check enabled
`clientId`	string	✓		MQTT client ID to use for all server definitions, rather than specifying the same one for each. Note that if neither the 'clientId' parameter nor an 'MqttClientId' are defined for an MQTT Server, a random MQTT Client ID will be generated automatically, prefaced with 'Camel'
`keepAliveTimeout`	integer		`30`	MQTT connection keep alive timeout, in seconds
`rebirthDebounceDelay`	integer		`5000`	Delay before recurring node rebirth messages will be sent
`servers`	string	✓		MQTT server definitions, given with the following syntax in a comma-separated list: MqttServerName:(MqttClientId:)(tcp/ssl)://hostname(:port),...
`metricDataTypePayloadMap`	object	✓		Tahu SparkplugBPayloadMap to configure metric data types for this edge node or device. Note that this payload is used exclusively as a Sparkplug B spec-compliant configuration for all possible edge node or device metric names, aliases, and data types. This configuration is required to publish proper Sparkplug B NBIRTH and DBIRTH payloads.
`headerFilterStrategy`	object			To use a custom HeaderFilterStrategy to filter headers used as Sparkplug metrics. Default value notice: Defaults to sending all Camel Message headers with name prefixes of CamelTahuMetric., including those with null values
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`bdSeqManager`	object		`org.apache.camel.component.tahu.CamelBdSeqManager`	To use a specific org.eclipse.tahu.message.BdSeqManager implementation to manage edge node birth-death sequence numbers
`bdSeqNumPath`	string		`${sys:java.io.tmpdir}/CamelTahuTemp`	Path for Sparkplug B NBIRTH/NDEATH sequence number persistence files. This path will contain files named as -bdSeqNum and must be writable by the executing process' user
`useAliases`	boolean		`false`	Flag enabling support for metric aliases
`deviceIds`	string			ID of each device connected to this edge node, as a comma-separated list
`primaryHostId`	string			Host ID of the primary host application for this edge node
`password`	string			Password for MQTT server authentication
`sslContextParameters`	object			SSL configuration for MQTT server connections
`username`	string			Username for MQTT server authentication