Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

improve sofdcar #139

Merged
merged 3 commits into from
Jun 28, 2023
Merged

improve sofdcar #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c742ef
refactor sofdcar
milesstoetzner Jun 28, 2023
88c37d4
minor
milesstoetzner Jun 28, 2023
d2baba0
Merge branch 'main' into improve-sofdcar
milesstoetzner Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/docs/sofdcar/tosca-sofdcar-profile-core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,24 @@ sofdcar.nodes.Steering:
derived_from: sofdcar.nodes.Actuator
```

#### sofdcar.nodes.Light

The node all other lights are derived from.

```yaml linenums="1"
sofdcar.nodes.Light:
derived_from: sofdcar.nodes.Actuator
```

#### sofdcar.nodes.Airbag

The node all other airbags are derived from.

```yaml linenums="1"
sofdcar.nodes.Airbag:
derived_from: sofdcar.nodes.Actuator
```

#### sofdcar.nodes.Sensor

The node all other sensors are derived from.
Expand Down
12 changes: 12 additions & 0 deletions docs/docs/sofdcar/tosca-sofdcar-profile-core.node-types.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ rectangle "sofdcar.nodes.Brake"

rectangle "sofdcar.nodes.Steering"

rectangle "sofdcar.nodes.Light"

rectangle "sofdcar.nodes.Airbag"

rectangle "sofdcar.nodes.Sensor"

rectangle "sofdcar.nodes.RADAR"
Expand All @@ -38,6 +42,8 @@ rectangle "sofdcar.nodes.Ultrasonic"

rectangle "sofdcar.nodes.Channel"

rectangle "sofdcar.nodes.Battery"


"tosca.nodes.Root" <|-- "sofdcar.nodes.Root"

Expand All @@ -63,6 +69,10 @@ rectangle "sofdcar.nodes.Channel"

"sofdcar.nodes.Actuator" <|-- "sofdcar.nodes.Steering"

"sofdcar.nodes.Actuator" <|-- "sofdcar.nodes.Light"

"sofdcar.nodes.Actuator" <|-- "sofdcar.nodes.Airbag"

"sofdcar.nodes.Root" <|-- "sofdcar.nodes.Sensor"

"sofdcar.nodes.Sensor" <|-- "sofdcar.nodes.RADAR"
Expand All @@ -75,4 +85,6 @@ rectangle "sofdcar.nodes.Channel"

"sofdcar.nodes.Root" <|-- "sofdcar.nodes.Channel"

"sofdcar.nodes.Root" <|-- "sofdcar.nodes.Battery"

@enduml
2 changes: 1 addition & 1 deletion docs/docs/sofdcar/tosca-sofdcar-profile-core.node-types.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/docs/sofdcar/tosca-sofdcar-profile-core.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,14 @@ node_types:
description: The node all other steerings are derived from.
derived_from: sofdcar.nodes.Actuator

sofdcar.nodes.Light:
description: The node all other lights are derived from.
derived_from: sofdcar.nodes.Actuator

sofdcar.nodes.Airbag:
description: The node all other airbags are derived from.
derived_from: sofdcar.nodes.Actuator

sofdcar.nodes.Sensor:
description: The node all other sensors are derived from.
derived_from: sofdcar.nodes.Root
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/sofdcar/tosca-sofdcar-profile-extended.capability-types.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ rectangle "sofdcar.capabilities.Endpoint.SOME/IP"

"sofdcar.capabilities.Endpoint" <|-- "sofdcar.capabilities.Endpoint.CAN"

"sofdcar.capabilities.Endpoint" <|-- "sofdcar.capabilities.Endpoint.CAN-FD"
"sofdcar.capabilities.Endpoint.CAN" <|-- "sofdcar.capabilities.Endpoint.CAN-FD"

"sofdcar.capabilities.Endpoint" <|-- "sofdcar.capabilities.Endpoint.LIN"

Expand All @@ -35,8 +35,8 @@ rectangle "sofdcar.capabilities.Endpoint.SOME/IP"

"sofdcar.capabilities.Endpoint" <|-- "sofdcar.capabilities.Endpoint.Ethernet"

"sofdcar.capabilities.Endpoint" <|-- "sofdcar.capabilities.Endpoint.OBD"
"sofdcar.capabilities.Endpoint.CAN" <|-- "sofdcar.capabilities.Endpoint.OBD"

"sofdcar.capabilities.Endpoint" <|-- "sofdcar.capabilities.Endpoint.SOME/IP"
"sofdcar.capabilities.Endpoint.Ethernet" <|-- "sofdcar.capabilities.Endpoint.SOME/IP"

@enduml
2 changes: 1 addition & 1 deletion docs/docs/sofdcar/tosca-sofdcar-profile-extended.capability-types.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 8 additions & 23 deletions docs/docs/sofdcar/tosca-sofdcar-profile-extended.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The capability to provide a CAN-FD endpoint.

```yaml linenums="1"
sofdcar.capabilities.Endpoint.CAN-FD:
derived_from: sofdcar.capabilities.Endpoint
derived_from: sofdcar.capabilities.Endpoint.CAN
```

#### sofdcar.capabilities.Endpoint.LIN
Expand Down Expand Up @@ -78,7 +78,7 @@ The capability to provide an OBD endpoint.

```yaml linenums="1"
sofdcar.capabilities.Endpoint.OBD:
derived_from: sofdcar.capabilities.Endpoint
derived_from: sofdcar.capabilities.Endpoint.CAN
```

#### sofdcar.capabilities.Endpoint.SOME/IP
Expand All @@ -87,7 +87,7 @@ The capability to provide a SOME/IP endpoint.

```yaml linenums="1"
sofdcar.capabilities.Endpoint.SOME/IP:
derived_from: sofdcar.capabilities.Endpoint
derived_from: sofdcar.capabilities.Endpoint.Ethernet
```

### Data Types
Expand Down Expand Up @@ -154,7 +154,7 @@ The CAN-FD channel all other CAN-FD channels are derived from.

```yaml linenums="1"
sofdcar.nodes.CAN-FD:
derived_from: sofdcar.nodes.Channel
derived_from: sofdcar.nodes.CAN
capabilities:
endpoint:
type: sofdcar.capabilities.Endpoint.CAN-FD
Expand Down Expand Up @@ -238,28 +238,13 @@ sofdcar.nodes.Ethernet:
- 2
```

#### sofdcar.nodes.OBD

The OBD channel all other OBD channels are derived from.

```yaml linenums="1"
sofdcar.nodes.OBD:
derived_from: sofdcar.nodes.Channel
capabilities:
endpoint:
type: sofdcar.capabilities.Endpoint.OBD
occurrences:
- 2
- 2
```

#### sofdcar.nodes.SOME/IP

The SOME/IP channel all other SOME/IP channels are derived from.

```yaml linenums="1"
sofdcar.nodes.SOME/IP:
derived_from: sofdcar.nodes.Channel
derived_from: sofdcar.nodes.Ethernet
capabilities:
endpoint:
type: sofdcar.capabilities.Endpoint.SOME/IP
Expand Down Expand Up @@ -443,7 +428,7 @@ The relationship for CAN-FD connections.

```yaml linenums="1"
sofdcar.relationships.CAN-FD:
derived_from: sofdcar.relationships.Root
derived_from: sofdcar.relationships.CAN
```

#### sofdcar.relationships.LIN
Expand Down Expand Up @@ -502,7 +487,7 @@ The relationship for OBD connections.

```yaml linenums="1"
sofdcar.relationships.OBD:
derived_from: sofdcar.relationships.Root
derived_from: sofdcar.relationships.CAN
```

#### sofdcar.relationships.SOME/IP
Expand All @@ -511,7 +496,7 @@ The relationship for SOME/IP connections.

```yaml linenums="1"
sofdcar.relationships.SOME/IP:
derived_from: sofdcar.relationships.Root
derived_from: sofdcar.relationships.Ethernet
```


8 changes: 2 additions & 6 deletions docs/docs/sofdcar/tosca-sofdcar-profile-extended.node-types.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ rectangle "sofdcar.nodes.FlexRay"

rectangle "sofdcar.nodes.Ethernet"

rectangle "sofdcar.nodes.OBD"

rectangle "sofdcar.nodes.SOME/IP"

rectangle "sofdcar.nodes.Python.Application"
Expand All @@ -35,7 +33,7 @@ rectangle "sofdcar.nodes.Arduino.Hardware"

"sofdcar.nodes.Channel" <|-- "sofdcar.nodes.CAN"

"sofdcar.nodes.Channel" <|-- "sofdcar.nodes.CAN-FD"
"sofdcar.nodes.CAN" <|-- "sofdcar.nodes.CAN-FD"

"sofdcar.nodes.Channel" <|-- "sofdcar.nodes.LIN"

Expand All @@ -47,9 +45,7 @@ rectangle "sofdcar.nodes.Arduino.Hardware"

"sofdcar.nodes.Channel" <|-- "sofdcar.nodes.Ethernet"

"sofdcar.nodes.Channel" <|-- "sofdcar.nodes.OBD"

"sofdcar.nodes.Channel" <|-- "sofdcar.nodes.SOME/IP"
"sofdcar.nodes.Ethernet" <|-- "sofdcar.nodes.SOME/IP"

"sofdcar.nodes.HPC.Software" <|-- "sofdcar.nodes.Python.Application"

Expand Down
Loading