package kuksa.val.v2

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Actuate (ActuateRequest, ActuateResponse)

  val.proto:106

  Actuate a single actuator Returns (GRPC error code): NOT_FOUND if the actuator does not exist. PERMISSION_DENIED if access is denied for the actuator. UNAUTHENTICATED if no credentials provided or credentials has expired UNAVAILABLE if there is no provider currently providing the actuator DATA_LOSS is there is a internal TransmissionFailure INVALID_ARGUMENT - if the provided path is not an actuator. - if the data type used in the request does not match the data type of the addressed signal - if the requested value is not accepted, e.g. if sending an unsupported enum value - if the provided value is out of the min/max range specified

• rpc ActuateStream (stream ActuateRequest, ActuateResponse)

  val.proto:124

  Actuate a single actuator in a gRPC stream -> Use for low latency and high throughput Returns (GRPC error code): NOT_FOUND if the actuator does not exist. PERMISSION_DENIED if access is denied for the actuator. UNAUTHENTICATED if no credentials provided or credentials has expired UNAVAILABLE if there is no provider currently providing the actuator DATA_LOSS is there is a internal TransmissionFailure INVALID_ARGUMENT - if the provided path is not an actuator. - if the data type used in the request does not match the data type of the addressed signal - if the requested value is not accepted, e.g. if sending an unsupported enum value - if the provided value is out of the min/max range specified

• rpc BatchActuate (BatchActuateRequest, BatchActuateResponse)

  val.proto:144

  Actuate simultaneously multiple actuators. If any error occurs, the entire operation will be aborted and no single actuator value will be forwarded to the provider. Returns (GRPC error code): NOT_FOUND if any of the actuators are non-existant. PERMISSION_DENIED if access is denied for any of the actuators. UNAUTHENTICATED if no credentials provided or credentials has expired UNAVAILABLE if there is no provider currently providing an actuator DATA_LOSS is there is a internal TransmissionFailure INVALID_ARGUMENT - if any of the provided path is not an actuator. - if the data type used in the request does not match the data type of the addressed signal - if the requested value is not accepted, e.g. if sending an unsupported enum value - if any of the provided actuators values are out of the min/max range specified

  message BatchActuateRequest

  val.proto:283

  • repeated ActuateRequest actuate_requests = 1

  message BatchActuateResponse

  val.proto:287

  (message has no fields)

• rpc GetServerInfo (GetServerInfoRequest, GetServerInfoResponse)

  val.proto:226

  Get server information

  message GetServerInfoRequest

  val.proto:414

  Nothing yet

  (message has no fields)

  message GetServerInfoResponse

  val.proto:418

  • string name = 1

  • string version = 2

  • string commit_hash = 3

• rpc GetValue (GetValueRequest, GetValueResponse)

  val.proto:35

  Get the latest value of a signal If the signal exist but does not have a valid value a DataPoint where value is None shall be returned. Returns (GRPC error code): NOT_FOUND if the requested signal doesn't exist UNAUTHENTICATED if no credentials provided or credentials has expired PERMISSION_DENIED if access is denied INVALID_ARGUMENT if the request is empty or provided path is too long - MAX_REQUEST_PATH_LENGTH: usize = 1000;

  message GetValueRequest

  val.proto:229

  • optional SignalID signal_id = 1

  message GetValueResponse

  val.proto:233

  • optional Datapoint data_point = 1

• rpc GetValues (GetValuesRequest, GetValuesResponse)

  val.proto:48

  Get the latest values of a set of signals. The returned list of data points has the same order as the list of the request. If a requested signal has no value a DataPoint where value is None will be returned. Returns (GRPC error code): NOT_FOUND if any of the requested signals doesn't exist. UNAUTHENTICATED if no credentials provided or credentials has expired PERMISSION_DENIED if access is denied for any of the requested signals. INVALID_ARGUMENT if the request is empty or provided path is too long - MAX_REQUEST_PATH_LENGTH: usize = 1000;

  message GetValuesRequest

  val.proto:237

  • repeated SignalID signal_ids = 1

  message GetValuesResponse

  val.proto:241

  • repeated Datapoint data_points = 1

• rpc ListMetadata (ListMetadataRequest, ListMetadataResponse)

  val.proto:153

  List metadata of signals matching the request. Returns (GRPC error code): NOT_FOUND if the specified root branch does not exist. UNAUTHENTICATED if no credentials provided or credentials has expired INVALID_ARGUMENT if the provided path or wildcard is wrong.

  message ListMetadataRequest

  val.proto:290

  • string root = 1

    Root path to be used when listing metadata Shall correspond to a VSS branch, e.g. "Vehicle", "Vehicle.Cabin" Metadata for all signals under that branch will be returned unless filtered by filter. NOTE: Currently Databroker supports also signals and wildcards in root but that may be removed in a future release!

  • string filter = 2

    NOTE : Currently not considered by Databroker, all signals matching root are returned

  message ListMetadataResponse

  val.proto:301

  • repeated Metadata metadata = 1

• rpc OpenProviderStream (stream OpenProviderStreamRequest, stream OpenProviderStreamResponse)

  val.proto:223

  Open a stream used to provide actuation and/or publishing values using a streaming interface. Used to provide actuators and to enable high frequency updates of values. The open stream is used for request / response type communication between the provider and server (where the initiator of a request can vary). Errors: - Provider sends ProvideActuationRequest -> Databroker returns ProvideActuationResponse - strict case Returns (GRPC error code) and closes the stream call NOT_FOUND if any of the signals are non-existant. PERMISSION_DENIED if access is denied for any of the signals. UNAUTHENTICATED if no credentials provided or credentials has expired ALREADY_EXISTS if a provider already claimed the ownership of an actuator - Provider sends PublishValuesRequest -> Databroker returns PublishValuesResponse upon error, and nothing upon success - permissive case GRPC errors are returned as messages in the stream response with the signal id `map<int32, Error> status = 2;` NOT_FOUND if a signal is non-existant. PERMISSION_DENIED - if access is denied for a signal. INVALID_ARGUMENT - if the data type used in the request does not match the data type of the addressed signal - if the published value is not accepted, e.g. if sending an unsupported enum value - if the published value is out of the min/max range specified - strict case Returns (GRPC error code) and closes the stream call. ALREADY_EXISTS if a provider already claimed the ownership of the signals ABORTED if provider has not claimed yet the signals - Databroker sends BatchActuateStreamRequest -> Provider shall return a BatchActuateStreamResponse, for every signal requested to indicate if the request was accepted or not. It is up to the provider to decide if the stream shall be closed, as of today Databroker will not react on the received error message. - Provider sends ProvideSignalRequest -> Databroker returns ProvideSignalResponse - strict case Returns (GRPC error code) and closes the stream call. NOT_FOUND if any of the signals are non-existant. PERMISSION_DENIED if access is denied for any of the signals. UNAUTHENTICATED if no credentials provided or credentials has expired ALREADY_EXISTS if a provider already claimed the ownership of any signal. - Provider sends ProviderErrorIndication - strict case Returns (GRPC error code) and closes the stream call. ABORTED if provider has not claimed yet the signals

  message OpenProviderStreamRequest

  val.proto:377

  • oneof action

    • ProvideActuationRequest provide_actuation_request = 1

      Inform server of an actuator this provider provides.

    • PublishValuesRequest publish_values_request = 2

      Publish a value.

    • BatchActuateStreamResponse batch_actuate_stream_response = 3

      Sent to acknowledge the acceptance of a batch actuate request.

    • ProvideSignalRequest provide_signal_request = 4

      Inform server of a signal this provider provides.

    • UpdateFilterResponse update_filter_response = 5

      Update filter response

    • GetProviderValueResponse get_provider_value_response = 6

      GetValue response

    • ProviderErrorIndication provider_error_indication = 7

      Indication of error on provider side

  message OpenProviderStreamResponse

  val.proto:397

  • oneof action

    • ProvideActuationResponse provide_actuation_response = 1

      Response to a provide actuator request.

    • PublishValuesResponse publish_values_response = 2

      Acknowledgement that a published value was received.

    • BatchActuateStreamRequest batch_actuate_stream_request = 3

      Send a batch actuate request to a provider.

    • ProvideSignalResponse provide_signal_response = 4

      Response to a provide sensor request.

    • UpdateFilterRequest update_filter_request = 5

      Filter request

    • GetProviderValueRequest get_provider_value_request = 6

      GetValue request from client forwarded to provider

• rpc PublishValue (PublishValueRequest, PublishValueResponse)

  val.proto:169

  Publish a signal value. Used for low frequency signals (e.g. attributes). Returns (GRPC error code): NOT_FOUND if any of the signals are non-existant. PERMISSION_DENIED - if access is denied for any of the signals. UNAUTHENTICATED if no credentials provided or credentials has expired INVALID_ARGUMENT - if the data type used in the request does not match the data type of the addressed signal - if the published value is not accepted, e.g. if sending an unsupported enum value - if the published value is out of the min/max range specified

  message PublishValueRequest

  val.proto:305

  • optional SignalID signal_id = 1

  • optional Datapoint data_point = 2

  message PublishValueResponse

  val.proto:310

  (message has no fields)

• rpc Subscribe (SubscribeRequest, stream SubscribeResponse)

  val.proto:68

  Subscribe to a set of signals using string path parameters Returns (GRPC error code): NOT_FOUND if any of the signals are non-existant. UNAUTHENTICATED if no credentials provided or credentials has expired PERMISSION_DENIED if access is denied for any of the signals. INVALID_ARGUMENT - if the request is empty or provided path is too long MAX_REQUEST_PATH_LENGTH: usize = 1000; - if buffer_size exceeds the maximum permitted MAX_BUFFER_SIZE: usize = 1000; When subscribing, Databroker shall immediately return the value for all subscribed entries. If a value isn't available when subscribing to a it, it should return None If a subscriber is slow to consume signals, messages will be buffered up to the specified buffer_size before the oldest messages are dropped.

  message SubscribeRequest

  val.proto:245

  • repeated string signal_paths = 1

  • uint32 buffer_size = 2

    Specifies the number of messages that can be buffered for slow subscribers before the oldest messages are dropped. Default (0) results in that only latest message is kept. Maximum value supported is implementation dependent.

  • optional Filter filter = 3

  message SubscribeResponse

  val.proto:256

  • map<string, Datapoint> entries = 1

• rpc SubscribeById (SubscribeByIdRequest, stream SubscribeByIdResponse)

  val.proto:88

  Subscribe to a set of signals using i32 id parameters Returns (GRPC error code): NOT_FOUND if any of the signals are non-existant. UNAUTHENTICATED if no credentials provided or credentials has expired PERMISSION_DENIED if access is denied for any of the signals. INVALID_ARGUMENT - if the request is empty or provided path is too long MAX_REQUEST_PATH_LENGTH: usize = 1000; - if buffer_size exceeds the maximum permitted MAX_BUFFER_SIZE: usize = 1000; When subscribing, Databroker shall immediately return the value for all subscribed entries. If a value isn't available when subscribing to a it, it should return None If a subscriber is slow to consume signals, messages will be buffered up to the specified buffer_size before the oldest messages are dropped.

  message SubscribeByIdRequest

  val.proto:260

  • repeated int32 signal_ids = 1

  • uint32 buffer_size = 2

    Specifies the number of messages that can be buffered for slow subscribers before the oldest messages are dropped. Default (0) results in that only latest message is kept. Maximum value supported is implementation dependent.

  • optional Filter filter = 3

  message SubscribeByIdResponse

  val.proto:271

  • map<int32, Datapoint> entries = 1

Used as request type in: VAL.Actuate, VAL.ActuateStream

Used as field type in: BatchActuateRequest, BatchActuateStreamRequest

• optional SignalID signal_id = 1

• optional Value value = 2

Used as response type in: VAL.Actuate, VAL.ActuateStream

(message has no fields)

Used in: OpenProviderStreamResponse

• repeated ActuateRequest actuate_requests = 1

Message that shall be used by provider to indicate if an actuation request was accepted.

Used in: OpenProviderStreamRequest

• optional SignalID signal_id = 1

• optional Error error = 2

Used in: Value

• repeated bool values = 1

VSS Data type of a signal Protobuf doesn't support int8, int16, uint8 or uint16. These are mapped to int32 and uint32 respectively.

Used in: Metadata

• DATA_TYPE_UNSPECIFIED = 0

• DATA_TYPE_STRING = 1

• DATA_TYPE_BOOLEAN = 2

• DATA_TYPE_INT8 = 3

• DATA_TYPE_INT16 = 4

• DATA_TYPE_INT32 = 5

• DATA_TYPE_INT64 = 6

• DATA_TYPE_UINT8 = 7

• DATA_TYPE_UINT16 = 8

• DATA_TYPE_UINT32 = 9

• DATA_TYPE_UINT64 = 10

• DATA_TYPE_FLOAT = 11

• DATA_TYPE_DOUBLE = 12

• DATA_TYPE_TIMESTAMP = 13

• DATA_TYPE_STRING_ARRAY = 20

• DATA_TYPE_BOOLEAN_ARRAY = 21

• DATA_TYPE_INT8_ARRAY = 22

• DATA_TYPE_INT16_ARRAY = 23

• DATA_TYPE_INT32_ARRAY = 24

• DATA_TYPE_INT64_ARRAY = 25

• DATA_TYPE_UINT8_ARRAY = 26

• DATA_TYPE_UINT16_ARRAY = 27

• DATA_TYPE_UINT32_ARRAY = 28

• DATA_TYPE_UINT64_ARRAY = 29

• DATA_TYPE_FLOAT_ARRAY = 30

• DATA_TYPE_DOUBLE_ARRAY = 31

• DATA_TYPE_TIMESTAMP_ARRAY = 32

A Datapoint represents a timestamped value. The 'value' field can be explicitly 'None', meaning the Datapoint exists but no value is present.

Used in: GetProviderValueResponse, GetValueResponse, GetValuesResponse, PublishValueRequest, PublishValuesRequest, SubscribeByIdResponse, SubscribeResponse

• optional google.protobuf.Timestamp timestamp = 1

  The timestamp of the datapoint.

• optional Value value = 2

  The value associated with the timestamp. If no value is present, this field can be 'None'.

Used in: Value

• repeated double values = 1

Entry type

Used in: Metadata

• ENTRY_TYPE_UNSPECIFIED = 0

• ENTRY_TYPE_ATTRIBUTE = 1

• ENTRY_TYPE_SENSOR = 2

• ENTRY_TYPE_ACTUATOR = 3

Used in: BatchActuateStreamResponse, PublishValuesResponse

• ErrorCode code = 1

• string message = 2

Used in: Error

• ERROR_CODE_UNSPECIFIED = 0

  Default value, never to be explicitly set,

• ERROR_CODE_OK = 1

• ERROR_CODE_INVALID_ARGUMENT = 2

• ERROR_CODE_NOT_FOUND = 3

• ERROR_CODE_PERMISSION_DENIED = 4

Used in: SubscribeByIdRequest, SubscribeRequest, UpdateFilterRequest

• uint32 duration_ms = 1

  Duration of the active call. If it is not set, call will last for ever.

• optional SampleInterval min_sample_interval = 2

  Min desired sample update interval.

Used in: UpdateFilterResponse

• FILTER_ERROR_CODE_UNSPECIFIED = 0

• FILTER_ERROR_CODE_UNKNOWN_SINGAL_ID = 1

Used in: Value

• repeated float values = 1

Used in: OpenProviderStreamResponse

• uint32 request_id = 1

  / Unique request id for the stream that can be used to match the corresponding response.

• repeated int32 signal_ids = 2

Used in: OpenProviderStreamRequest

• uint32 request_id = 1

  / Unique request id for the stream that can be used to match the corresponding request.

• map<int32, Datapoint> entries = 2

Used in: Value

• repeated sint32 values = 1

Used in: Value

• repeated sint64 values = 1

Used in: ListMetadataResponse

• string path = 9

  Full dot notated path for the signal

• int32 id = 10

  ID field

• DataType data_type = 11

  Data type The VSS data type of the entry (i.e. the value, min, max etc). NOTE: protobuf doesn't have int8, int16, uint8 or uint16 which means that these values must be serialized as int32 and uint32 respectively.

• EntryType entry_type = 12

  Entry type

• string description = 13

  Description Describes the meaning and content of the entry.

• string comment = 14

  Comment A comment can be used to provide additional informal information on a entry.

• string deprecation = 15

  Deprecation Whether this entry is deprecated. Can contain recommendations of what to use instead.

• string unit = 16

  Unit The unit of measurement

• optional Value allowed_values = 17

  Value restrictions checked/enforced by Databroker

  Must be of array type

• optional Value min = 18

• optional Value max = 19

• optional SampleInterval min_sample_interval = 20

  Minimum sample interval at which its provider can publish the signal value

Used in: OpenProviderStreamRequest

• repeated SignalID actuator_identifiers = 1

Used in: OpenProviderStreamResponse

(message has no fields)

Used in: OpenProviderStreamRequest

• map<int32, SampleInterval> signals_sample_intervals = 1

Used in: OpenProviderStreamResponse

(message has no fields)

Could be extended in the future with more errors

Used in: ProviderErrorIndication

• CODE_UNSPECIFIED = 0

• CODE_NETWORK_ERROR = 1

• CODE_OVERLOAD = 2

Send to indicate an error on provider side

Used in: OpenProviderStreamRequest

• ProviderError provider_error = 1

Used in: OpenProviderStreamRequest

• uint32 request_id = 1

  / Unique request id for the stream that can be used to match the corresponding response.

• map<int32, Datapoint> data_points = 2

Used in: OpenProviderStreamResponse

• uint32 request_id = 1

  / Unique request id for the stream that can be used to match the corresponding request.

• map<int32, Error> status = 2

Used in: Filter, Metadata, ProvideSignalRequest

• uint32 interval_ms = 1

Used in: ActuateRequest, BatchActuateStreamResponse, GetValueRequest, GetValuesRequest, ProvideActuationRequest, PublishValueRequest

• oneof signal

  • int32 id = 1

    Numeric identifier to the signal As of today Databroker assigns arbitrary unique numbers to each registered signal at startup, meaning that identifiers may change after restarting Databroker. A mechanism for static identifiers may be introduced in the future.

  • string path = 2

    Full VSS-style path to a specific signal, like "Vehicle.Speed" Wildcards and paths to branches are not supported. The given path must be known by the Databroker.

Used in: Value

• repeated string values = 1

Used in: Value

• repeated uint32 values = 1

Used in: Value

• repeated uint64 values = 1

Used in: OpenProviderStreamResponse

• uint32 request_id = 1

  / Unique request id for the stream that can be used to match the corresponding response.

• map<int32, Filter> filters_update = 2

  Databroker sends filters to provider. In case provider restarts, databroker will send local filters stored to continue the provider sending same signals with same filter. Filter value could be None, meaning all subscriptions were removed for that SignalId

Only returned if there is a filter error on provider side

Used in: OpenProviderStreamRequest

• uint32 request_id = 1

  / Unique request id for the stream that can be used to match the corresponding request.

• FilterError filter_error = 2

Used in: ActuateRequest, Datapoint, Metadata

• oneof typed_value

  • string string = 11

  • bool bool = 12

  • sint32 int32 = 13

  • sint64 int64 = 14

  • uint32 uint32 = 15

  • uint64 uint64 = 16

  • float float = 17

  • double double = 18

  • StringArray string_array = 21

  • BoolArray bool_array = 22

  • Int32Array int32_array = 23

  • Int64Array int64_array = 24

  • Uint32Array uint32_array = 25

  • Uint64Array uint64_array = 26

  • FloatArray float_array = 27

  • DoubleArray double_array = 28