Skip to content

Latest commit

 

History

History
125 lines (80 loc) · 5.32 KB

README.adoc

File metadata and controls

125 lines (80 loc) · 5.32 KB
Raw

uProtocol Logo

Eclipse-uProtocol Specification

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in IETF BCP14 (RFC2119 & RFC8174)

Copyright (c) 2023 General Motors GTO LLC

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

SPDX-FileType: DOCUMENTATION
SPDX-FileCopyrightText: 2023 General Motors GTO LLC
SPDX-License-Identifier: Apache-2.0

1. Purpose

A software defined vehicle requires the design and development of software entities that are distributed by nature, deployed in different os/hw environments (mechatronics, high-compute, mobile phones, and the cloud).

Every environment have their own software development, deployment, and communications protocols, thus resulting in no common interface,language or means for said distributed software to seamlessly discover, connect, and communicate with each other in a transparent, simplified, and secure manner.

uProtocol addresses the above-mentioned problem by defining an ubiquitous language that includes:

  1. Transport layer interface: Common way to send() and receive() messages regardless of the underlining networking transport protocol

  2. Common Message Definitions

  3. Common application layer interfaces for core business logic (ex. subscription management, discovery, etc…​)

uProtocol Overview image below provides a high-level view of what we aim to define in this specification. The arrows between the uEs are the physical/virtual transport (anything from OSI layer 2 protocol up to automotive/Internet application layer protocols, and everything in-between. The icon CloudEvents represents the messages sent between uEs that, for the remainder of this document, referred to as CloudEvents or CEs.

Overview
Figure 1. uProtocol Overview

2. The Basics

In this section of the specifications we cover the foundations of uProtocol such as CloudEvents, UUIDs, naming conventions and more.

3. Layers

uProtocol Layers
Figure 2. uProtocol Layers

uProtocol consists of three layers as depicted in uProtocol Layers above, they are:

  1. Transport & Session Layer (uP-L1): Bidirectional point-2-point communication between uEs (how messages are sent and received between uEs).

  2. Communication (Messaging) Layer (uP-L2): Defines the message types, headers, format, and delivery semantics. uProtocol builds upon CNCF CloudEvent specifications as a way to describe the messages in a common way

  3. Application Layer (uP-L3): Also known as the business logic layer, responsible for declaration and definition of interfaces between clients and servers (ex. subscription management, discovery, etc…​)

4. Software Entities (uEs)

A uE is software that communicates with other software using uProtocol.

uE Classifications below illustrates the set of uProtocol defined uEs required to implement the protocol.

uEs
Figure 3. uE Classifications

4.1. Communication Backbone

uEs in this category are essential for dispatching/routing of messages between uEs, uDevices, and uDomains.

Table 1. Communication uEs
uE Name Description

Dispatchers

Message dispatches sending CEs between uEs, between devices, etc…​

uSubscription

Implement the publisher/subscriber architecture pattern within and between devices. Used by dispatchers to multicast messages to subscribers

4.2. Core uEs

Core uEs are business layer logic to perform a specific function of the protocol highlighted in the table below.

Table 2. Core uEs
uE Name Description

uDiscovery

Discovery (services, devices, topics, methods, properties, etc…​)

uTwin

Local (to the device) caches of published information for subscribed topics

4.3. Topology

Topology below illustrates what a uProtcol topology consists of when all the uEs connected together.

uProtocol Topology
Figure 4. Topology
Note
 Please see Guiding Principles for more information about motivations and high-level requirements/principles driving the specification