Crate lelum_varlink

Crate lelum_varlink 

Expand description

Varlink API for LeLuM.

This crate provides both client and server implementations.

§Features

  • client: Enables the client implementation.
  • server: Enables the server implementation.

§API

§com.inomotech.Lelum.Health

Parameters: None

Returns: HealthReport

Retrieves a health report from the Lelum service.

§com.inomotech.Lelum.Read

Parameters:

  • path: VSS-defined path to a data entry node. E.g.: Vehicle.VehicleIdentification.VIN.

Returns: DataEntryValue

Reads the current value of the data entry node at the specified path.

§com.inomotech.Lelum.Query

Parameters:

  • root (optional): Path to the branch node to query from. If not provided, the VSS root branch is used.
  • depth (optional): Maximum depth to traverse starting from root. If not provided, all child nodes are included. A depth of 0 yields an empty result as it only includes the root branch, which is not a data entry node.
  • include_values (optional): Whether to include the current values of the data entry nodes in the response.

Returns: QueryResult

Runs a query against the VSS tree.

For statically known paths, prefer using Read. Even when reading multiple known paths, multiple chained calls to Read are likely to be more efficient than using Query.

§com.inomotech.Lelum.Update

Parameters:

  • path: VSS-defined path to a data entry node. E.g.: Vehicle.VehicleIdentification.VIN.
  • value: New value to set for the data entry node.

Returns: DataEntryValue

Updates the value of the data entry node at the specified path. Please note that this currently only influences the shadow value and doesn’t apply it to the vehicle.

Re-exports§

Modules§

clientclient
API client.
serverserver
API server.
types 🔒

Structs§

DataEntryValue
Represents the value of a data entry node.
HealthReport
Represents a health report returned by the Lelum service.
Node
VSS Node representation.
QueryResult
Result of a com.inomotech.Lelum.Query call.

Enums§

LelumError
Represents errors returned by Lelum.

Constants§

DEFAULT_SOCKET_PATH
Default path to the LeLuM Varlink socket.