Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions docs/using-raw-protobuf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Using the Protobuf protocol directly

## Example diagram

``` mermaid
classDiagram
Person <|-- Student
Person <|-- Professor
Person : +String name
Person : +String phoneNumber
Person : +String emailAddress
Person: +purchaseParkingPass()
Address "1" <-- "0..1" Person:lives at
class Student{
+int studentNumber
+int averageMark
+isEligibleToEnrol()
+getSeminarsTaken()
}
class Professor{
+int salary
}
class Address{
+String street
+String city
+String state
+int postalCode
+String country
-validate()
+outputAsLabel()
}
```
8 changes: 7 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,12 @@ markdown_extensions:
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.tilde
- pymdownx.snippets
- pymdownx.tabbed:
Expand Down Expand Up @@ -97,6 +102,7 @@ nav:
- "Visualizing with Foxglove": "foxglove-bridge.md"
- "Forwarding positioning to NMEA": "nmea-publisher.md"
- "Updating from v1 to v2": "migrating-to-v2.md"
- "Using the Protobuf protocol directly": "using-raw-protobuf.md"
- "HTTP API": "http-api.html"
- Reference:
- blueye.sdk.battery: "reference/blueye/sdk/battery.md"
Expand Down
Loading