diff --git a/doc/content/schemas/yaml/Network.md b/doc/content/schemas/yaml/Network.md new file mode 100644 index 0000000..0dd6864 --- /dev/null +++ b/doc/content/schemas/yaml/Network.md @@ -0,0 +1,199 @@ +--- +title: "Schema: Network" +linkTitle: "Network" +--- + +(v0.0.1) + +

Network

+ + + + + + +```yaml +kind: Network +metadata: + name: CAN1 + annotations: + message_lib: examples/stub/data/message.so + function_lib: examples/stub/data/function.so +spec: + messages: + - message: systemStatus + annotations: + struct_name: CAN1_systemStatus_t + struct_size: 4 + frame_id: 0x1f0u + frame_length: 8u + signals: + - signal: Crc + annotations: + struct_member_name: crc + struct_member_offset: 0 + struct_member_primitive_type: uint8_t + - signal: Alive + annotations: + struct_member_name: alive + struct_member_offset: 1 + struct_member_primitive_type: uint8 + - signal: Temperature + annotations: + struct_member_name: temperature + struct_member_offset: 2 + struct_member_primitive_type: int16_t + functions: + encode: + - function: counter_inc_uint8 + annotations: + position: 1 + - function: crc_generate + annotations: + position: 0 + decode: + - function: crc_validate + annotations: + position: 0 + +``` + +A Network definition. + +### Supported annotations: +|Annotation|Description| +|---|---| +|`message_lib`|Relative path of the shared library containing the Network Message symbols.| +|`function_lib`|Relative path of the shared library containing Network Function symbols.| + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|kind|string|true|none| +|metadata|object|false|Information relating to an object.| +|» name|string|false|The name of the object.| +|» labels|object|false|Identifying information used to identify objects within the system (e.g. giving a specific 'label' to an object).| +|»» **additionalProperties**|string|false|none| +|» annotations|object|false|Non identifying information (i.e. information specific to the object itself).| +|»» **additionalProperties**|string|false|none| +|spec|object|true|none| +|» messages|[[Message](#schemamessage)]|true|A list of messages belonging to this Network.| + +#### Enumerated Values + +|Property|Value| +|---|---| +|kind|Network| + +

Message

+ + + + + + +```yaml +message: systemStatus +annotations: + struct_name: CAN1_systemStatus_t + struct_size: 4 + frame_id: 0x1f0u + frame_length: 8u +signals: + - signal: Crc + annotations: + struct_member_name: crc + struct_member_offset: 0 + struct_member_primitive_type: uint8_t +functions: + encode: + - function: crc_generate + annotations: + position: 0 + decode: + - function: crc_validate + annotations: + position: 0 + +``` + +A Network message definition. + +### Supported annotations: +|Annotation|Description| +|---|---| +|`struct_name`|Name of the typedef/struct representing the message.| +|`struct_size`|Size of the message struct (in bytes).| +|`frame_id`|The frame id of the message when encoded to a bus transport (e.g. CAN Frame ID).| +|`frame_length`|The length of the message when encoded (in bytes).| + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|message|string|true|The name of the message.| +|annotations|object|false|Non identifying information (i.e. information specific to the object itself).| +|» **additionalProperties**|string|false|none| +|signals|[[Signal](#schemasignal)]|false|A list of signals represented in this message.| +|functions|object|false|Message functions to be applied to this message.| +|» encode|[[Function](#schemafunction)]|false|Message functions applied to the encode processing path (i.e. from Signal to Network interface). Functions are implicitly applied in the order of definition.| +|» decode|[[Function](#schemafunction)]|false|Message functions applied to the decode processing path (i.e. from Network to Signal interface). Functions are implicitly applied in the order of definition.| + +

Signal

+ + + + + + +```yaml +signal: Temperature +annotations: + struct_member_name: temperature + struct_member_offset: 2 + struct_member_primitive_type: int16_t + +``` + +A Network signal definition. + +### Supported annotations: +|Annotation|Description| +|---|---| +|`struct_member_name`|Name of the struct member which represents this signal.| +|`struct_member_offset`|Offset of the member in the struct (in bytes).| +|`struct_member_primitive_type`|The primitive type of the member (select from int8_t, int16_t, int32_t, int64_t, uint8_t, uint16_t, uint32_t, uint64_t).| + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|signal|string|true|The name of the signal.| +|annotations|[Message/properties/annotations](#schemamessage/properties/annotations)|false|Non identifying information (i.e. information specific to the object itself).| + +

Function

+ + + + + + +```yaml +function: crc_generate +annotations: + position: 0 + +``` + +A Network Function definition. + +### Properties + +|Name|Type|Required|Description| +|---|---|---|---| +|function|string|true|The name of the function (i.e. the name of the symbol _in_ the Network Function shared library).| +|annotations|[Message/properties/annotations](#schemamessage/properties/annotations)|false|Non identifying information (i.e. information specific to the object itself).| + +undefined + diff --git a/schemas/yaml/Network.yaml b/schemas/yaml/Network.yaml new file mode 100644 index 0000000..0b47050 --- /dev/null +++ b/schemas/yaml/Network.yaml @@ -0,0 +1,193 @@ +# Copyright 2023 Robert Bosch GmbH +# +# SPDX-License-Identifier: Apache-2.0 + +--- +openapi: 3.0.0 +info: + title: Network + version: 0.0.1 +paths: + /Network: + get: + responses: + '200': + description: '' +components: + schemas: + Network: + description: | + A Network definition. + + ### Supported annotations: + |Annotation|Description| + |---|---| + |`message_lib`|Relative path of the shared library containing the Network Message symbols.| + |`function_lib`|Relative path of the shared library containing Network Function symbols.| + type: object + required: + - kind + - spec + properties: + kind: + type: string + enum: + - Network + metadata: + $ref: 'metadata.yaml#/components/schemas/ObjectMetadata' + spec: + type: object + required: + - messages + properties: + messages: + type: array + description: A list of messages belonging to this Network. + items: + $ref: '#/components/schemas/Message' + example: + kind: Network + metadata: + name: CAN1 + annotations: + message_lib: examples/stub/data/message.so + function_lib: examples/stub/data/function.so + spec: + messages: + - message: systemStatus + annotations: + struct_name: CAN1_systemStatus_t + struct_size: 4 + frame_id: 0x1f0u + frame_length: 8u + signals: + - signal: Crc + annotations: + struct_member_name: crc + struct_member_offset: 0 + struct_member_primitive_type: uint8_t + - signal: Alive + annotations: + struct_member_name: alive + struct_member_offset: 1 + struct_member_primitive_type: uint8 + - signal: Temperature + annotations: + struct_member_name: temperature + struct_member_offset: 2 + struct_member_primitive_type: int16_t + functions: + encode: + - function: counter_inc_uint8 + annotations: + position: 1 + - function: crc_generate + annotations: + position: 0 + decode: + - function: crc_validate + annotations: + position: 0 + Message: + type: object + description: | + A Network message definition. + + ### Supported annotations: + |Annotation|Description| + |---|---| + |`struct_name`|Name of the typedef/struct representing the message.| + |`struct_size`|Size of the message struct (in bytes).| + |`frame_id`|The frame id of the message when encoded to a bus transport (e.g. CAN Frame ID).| + |`frame_length`|The length of the message when encoded (in bytes).| + required: + - message + properties: + message: + type: string + description: The name of the message. + example: systemStatus + annotations: + $ref: 'metadata.yaml#/components/schemas/Annotations' + signals: + type: array + description: A list of signals represented in this message. + items: + $ref: '#/components/schemas/Signal' + functions: + type: object + description: Message functions to be applied to this message. + properties: + encode: + type: array + description: Message functions applied to the encode processing path (i.e. from Signal to Network interface). Functions are implicitly applied in the order of definition. + items: + $ref: '#/components/schemas/Function' + decode: + type: array + description: Message functions applied to the decode processing path (i.e. from Network to Signal interface). Functions are implicitly applied in the order of definition. + items: + $ref: '#/components/schemas/Function' + example: + message: systemStatus + annotations: + struct_name: CAN1_systemStatus_t + struct_size: 4 + frame_id: 0x1f0u + frame_length: 8u + signals: + - signal: Crc + annotations: + struct_member_name: crc + struct_member_offset: 0 + struct_member_primitive_type: uint8_t + functions: + encode: + - function: crc_generate + annotations: + position: 0 + decode: + - function: crc_validate + annotations: + position: 0 + Signal: + type: object + description: | + A Network signal definition. + + ### Supported annotations: + |Annotation|Description| + |---|---| + |`struct_member_name`|Name of the struct member which represents this signal.| + |`struct_member_offset`|Offset of the member in the struct (in bytes).| + |`struct_member_primitive_type`|The primitive type of the member (select from int8_t, int16_t, int32_t, int64_t, uint8_t, uint16_t, uint32_t, uint64_t).| + required: + - signal + properties: + signal: + type: string + description: The name of the signal. + annotations: + $ref: 'metadata.yaml#/components/schemas/Annotations' + example: + signal: Temperature + annotations: + struct_member_name: temperature + struct_member_offset: 2 + struct_member_primitive_type: int16_t + Function: + type: object + description: | + A Network Function definition. + required: + - function + properties: + function: + type: string + description: The name of the function (i.e. the name of the symbol _in_ the Network Function shared library). + annotations: + $ref: 'metadata.yaml#/components/schemas/Annotations' + example: + function: crc_generate + annotations: + position: 0