package kuksa.val.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Get (GetRequest, GetResponse)

  val.proto:35

  Get entries

  message GetRequest

  val.proto:63

  Request a set of entries.

  • repeated EntryRequest entries = 1

  message GetResponse

  val.proto:69

  Global errors are specified in `error`. Errors for individual entries are specified in `errors`.

  • repeated DataEntry entries = 1

  • repeated DataEntryError errors = 2

  • optional Error error = 3

• rpc GetServerInfo (GetServerInfoRequest, GetServerInfoResponse)

  val.proto:52

  Shall return information that allows the client to determine what server/server implementation/version it is talking to eg. kuksa-databroker 0.5.1

  message GetServerInfoRequest

  val.proto:119

  Nothing yet

  (message has no fields)

  message GetServerInfoResponse

  val.proto:123

  • string name = 1

  • string version = 2

• rpc Set (SetRequest, SetResponse)

  val.proto:38

  Set entries

  message SetRequest

  val.proto:82

  A list of entries to be updated

  • repeated EntryUpdate updates = 1

  message SetResponse

  val.proto:88

  Global errors are specified in `error`. Errors for individual entries are specified in `errors`.

  • optional Error error = 1

  • repeated DataEntryError errors = 2

• rpc StreamedUpdate (stream StreamedUpdateRequest, stream StreamedUpdateResponse)

  val.proto:40

  message StreamedUpdateRequest

  val.proto:93

  • repeated EntryUpdate updates = 1

  message StreamedUpdateResponse

  val.proto:97

  • optional Error error = 1

  • repeated DataEntryError errors = 2

• rpc Subscribe (SubscribeRequest, stream SubscribeResponse)

  val.proto:47

  Subscribe to a set of entries Returns a stream of notifications. InvalidArgument is returned if the request is malformed.

  message SubscribeRequest

  val.proto:110

  Subscribe to changes in datapoints.

  • repeated SubscribeEntry entries = 1

  message SubscribeResponse

  val.proto:115

  A subscription response

  • repeated EntryUpdate updates = 1

///////////////////// Actuator specific fields

Nothing for now

Used in: Metadata

(message has no fields)

////////////////////// Attribute specific

Nothing for now.

Used in: Metadata

(message has no fields)

Used in: Datapoint

• repeated bool values = 1

Describes a VSS entry When requesting an entry, the amount of information returned can be controlled by specifying either a `View` or a set of `Field`s.

Used in: EntryUpdate, GetResponse

• string path = 1

  Defines the full VSS path of the entry.

  [field: FIELD_PATH]

• optional Datapoint value = 2

  The value (datapoint)

  [field: FIELD_VALUE]

• optional Datapoint actuator_target = 3

  Actuator target (only used if the entry is an actuator)

  [field: FIELD_ACTUATOR_TARGET]

• optional Metadata metadata = 10

  Metadata for this entry

  [field: FIELD_METADATA]

Used in get/set requests to report errors for specific entries

Used in: GetResponse, SetResponse, StreamedUpdateResponse

• string path = 1

  vss path

• optional Error error = 2

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

Used in: DataEntry

• optional google.protobuf.Timestamp timestamp = 1

• oneof 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

Used in: Datapoint

• repeated double values = 1

Define which data we want

Used in: GetRequest

• string path = 1

• View view = 2

• repeated Field fields = 3

Entry type

Used in: Metadata

• ENTRY_TYPE_UNSPECIFIED = 0

• ENTRY_TYPE_ATTRIBUTE = 1

• ENTRY_TYPE_SENSOR = 2

• ENTRY_TYPE_ACTUATOR = 3

Define the data we want to set

Used in: SetRequest, StreamedUpdateRequest, SubscribeResponse

• optional DataEntry entry = 1

• repeated Field fields = 2

Error response shall be an HTTP-like code. Should follow https://www.w3.org/TR/viss2-transport/#status-codes.

Used in: DataEntryError, GetResponse, SetResponse, StreamedUpdateResponse

• uint32 code = 1

• string reason = 2

• string message = 3

A `Field` corresponds to a specific field of a `DataEntry`. It can be used to: * populate only specific fields of a `DataEntry` response. * specify which fields of a `DataEntry` should be set as part of a `Set` request. * subscribe to only specific fields of a data entry. * convey which fields of an updated `DataEntry` have changed.

Used in: EntryRequest, EntryUpdate, SubscribeEntry

• FIELD_UNSPECIFIED = 0

  "*" i.e. everything

• FIELD_PATH = 1

  path

• FIELD_VALUE = 2

  value

• FIELD_ACTUATOR_TARGET = 3

  actuator_target

• FIELD_METADATA = 10

  metadata.*

• FIELD_METADATA_DATA_TYPE = 11

  metadata.data_type

• FIELD_METADATA_DESCRIPTION = 12

  metadata.description

• FIELD_METADATA_ENTRY_TYPE = 13

  metadata.entry_type

• FIELD_METADATA_COMMENT = 14

  metadata.comment

• FIELD_METADATA_DEPRECATION = 15

  metadata.deprecation

• FIELD_METADATA_UNIT = 16

  metadata.unit

• FIELD_METADATA_VALUE_RESTRICTION = 17

  metadata.value_restriction.*

• FIELD_METADATA_ACTUATOR = 20

  metadata.actuator.*

• FIELD_METADATA_SENSOR = 30

  metadata.sensor.*

• FIELD_METADATA_ATTRIBUTE = 40

  metadata.attribute.*

Used in: Datapoint

• repeated float values = 1

Used in: Datapoint

• repeated sint32 values = 1

Used in: Datapoint

• repeated sint64 values = 1

Used in: DataEntry

• 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.

  [field: FIELD_METADATA_DATA_TYPE]

• EntryType entry_type = 12

  Entry type

  [field: FIELD_METADATA_ENTRY_TYPE]

• optional string description = 13

  Description Describes the meaning and content of the entry.

  [field: FIELD_METADATA_DESCRIPTION]

• optional string comment = 14

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

  [field: FIELD_METADATA_COMMENT]

• optional string deprecation = 15

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

  [field: FIELD_METADATA_DEPRECATION]

• optional string unit = 16

  Unit [optional] The unit of measurement

  [field: FIELD_METADATA_UNIT]

• optional ValueRestriction value_restriction = 17

  Value restrictions [optional] Restrict which values are allowed. Only restrictions matching the DataType {datatype} above are valid.

  [field: FIELD_METADATA_VALUE_RESTRICTION]

• oneof entry_specific

  Entry type specific metadata

  • Actuator actuator = 20

    [field: FIELD_METADATA_ACTUATOR]

  • Sensor sensor = 30

    [field: FIELD_METADATA_SENSOR]

  • Attribute attribute = 40

    [field: FIELD_METADATA_ATTRIBUTE]

////////////////////// Sensor specific

Nothing for now

Used in: Metadata

(message has no fields)

Used in: Datapoint

• repeated string values = 1

Define what to subscribe to

Used in: SubscribeRequest

• string path = 1

• View view = 2

• repeated Field fields = 3

Used in: Datapoint

• repeated uint32 values = 1

Used in: Datapoint

• repeated uint64 values = 1

Value restriction One ValueRestriction{type} for each type, since they don't make sense unless the types match

Used in: Metadata

• oneof type

  • ValueRestrictionString string = 21

  • ValueRestrictionInt signed = 22

    For signed VSS integers

  • ValueRestrictionUint unsigned = 23

    For unsigned VSS integers

  • ValueRestrictionFloat floating_point = 24

    For floating point VSS values (float and double)

Used in: ValueRestriction

• optional double min = 1

• optional double max = 2

• repeated double allowed_values = 3

  allowed for doubles/floats not recommended

Used in: ValueRestriction

• optional sint64 min = 1

• optional sint64 max = 2

• repeated sint64 allowed_values = 3

min, max doesn't make much sense for a string

Used in: ValueRestriction

• repeated string allowed_values = 3

Used in: ValueRestriction

• optional uint64 min = 1

• optional uint64 max = 2

• repeated uint64 allowed_values = 3

A `View` specifies a set of fields which should be populated in a `DataEntry` (in a response message)

Used in: EntryRequest, SubscribeEntry

• VIEW_UNSPECIFIED = 0

  Unspecified. Equivalent to VIEW_CURRENT_VALUE unless `fields` are explicitly set.

• VIEW_CURRENT_VALUE = 1

  Populate DataEntry with value.

• VIEW_TARGET_VALUE = 2

  Populate DataEntry with actuator target.

• VIEW_METADATA = 3

  Populate DataEntry with metadata.

• VIEW_FIELDS = 10

  Populate DataEntry only with requested fields.

• VIEW_ALL = 20

  Populate DataEntry with everything.