From 60e61df7bd1b790ee025b5a1267965cb2bd5fe07 Mon Sep 17 00:00:00 2001 From: hhenry01 Date: Tue, 14 Nov 2023 20:11:08 -0800 Subject: [PATCH 1/6] Add sequence diagrams --- .../diagrams/common_sequence.puml | 44 +++++++++++++++++++ .../diagrams/deployment_sequence.puml | 13 ++++++ .../diagrams/simulation_sequence.puml | 26 +++++++++++ 3 files changed, 83 insertions(+) create mode 100644 projects/can_transceiver/diagrams/common_sequence.puml create mode 100644 projects/can_transceiver/diagrams/deployment_sequence.puml create mode 100644 projects/can_transceiver/diagrams/simulation_sequence.puml diff --git a/projects/can_transceiver/diagrams/common_sequence.puml b/projects/can_transceiver/diagrams/common_sequence.puml new file mode 100644 index 0000000..4b3eabf --- /dev/null +++ b/projects/can_transceiver/diagrams/common_sequence.puml @@ -0,0 +1,44 @@ +@startuml Common Sequence +title Common Sequence + +!startsub PARTICIPANTS +' TODO: Move parameters to a general template +autonumber +!$MAX_MESSAGE_SIZE = 100 +skinparam { + BoxPadding 10 + MaxMessageSize $MAX_MESSAGE_SIZE + ParticipantPadding 20 + SequenceMessageAlign center + wrapWidth $MAX_MESSAGE_SIZE +} + +box "Common Sequence" +participant CanTransceiver as can +participant CanTransceiverRosIntf as ros_intf +end box +== Inbound == +!endsub PARTICIPANTS + +-> can : Inbound Sensor(s) [CAN] + +!startsub SEQUENCE + +activate can +can -> can : Convert from CAN to ROS +can -> can : Filter Sensor(s) +can -> ros_intf --++ : Transmit Sensor(s) [ROS] +ros_intf -> : Publish sensor(s) to Software ROS Network +deactivate ros_intf + +== Outbound == + +ros_intf <- ++ : Command(s) from Software ROS Network (ex. Desired Heading) +can <- ros_intf --++ : Transmit Command(s) [ROS] +can -> can : Convert Command(s) from ROS to CAN +!endsub SEQUENCE + +<- can : Outbound Command(s) [CAN] +deactivate can + +@enduml diff --git a/projects/can_transceiver/diagrams/deployment_sequence.puml b/projects/can_transceiver/diagrams/deployment_sequence.puml new file mode 100644 index 0000000..9096560 --- /dev/null +++ b/projects/can_transceiver/diagrams/deployment_sequence.puml @@ -0,0 +1,13 @@ +@startuml Deployment Sequence + +title Deployment Sequence + +!includesub common_sequence.puml!PARTICIPANTS + +-> can : Sensors from ELEC [CAN] + +!includesub common_sequence.puml!SEQUENCE + +<- can -- : Transmit Command(s) to ELEC [CAN] + +@enduml diff --git a/projects/can_transceiver/diagrams/simulation_sequence.puml b/projects/can_transceiver/diagrams/simulation_sequence.puml new file mode 100644 index 0000000..da44e3d --- /dev/null +++ b/projects/can_transceiver/diagrams/simulation_sequence.puml @@ -0,0 +1,26 @@ +@startuml Simulation Sequence + +title Simulation Sequence + +box "Simulation Sequence" +participant CanSimIntf as sim_intf +participant CanSimTransceiver as sim_t +end box + +!includesub common_sequence.puml!PARTICIPANTS + +-> sim_intf ++ : Mock Sensors from Simulator [ROS] +sim_intf -> sim_t --++ : Process Mock Sensors [ROS] +sim_t -> sim_t : Convert ROS sensor object to CAN +sim_t --> can -- : Call new Sensors API [CAN] +deactivate sim_intf +note right sim_t : API call should be async to replicate deployment behavior. + +!includesub common_sequence.puml!SEQUENCE + +sim_t <-- can --++ : Call Write to CAN API +note left can : API call should be async to replicate deployment behavior. +sim_t -> sim_t : Convert Command(s) from CAN to ROS +sim_intf <- sim_t --++ : Transmit Command(s) [ROS] +activate sim_intf +<- sim_intf -- : Publish Command(s) to Simulator [ROS] From 9b8c5c9f46e3a577813a82b578d64354d7e8e378 Mon Sep 17 00:00:00 2001 From: hhenry01 Date: Mon, 20 Nov 2023 16:50:20 -0800 Subject: [PATCH 2/6] Add Local Transceiver Diagrams --- .../diagrams/common_sequence.puml | 13 ++---- .../diagrams/deployment_sequence.puml | 5 ++- .../diagrams/simulation_sequence.puml | 5 ++- .../diagrams/inbound_sequence.puml | 25 ++++++++++++ .../diagrams/outbound_sequence.puml | 40 +++++++++++++++++++ .../diagrams/participants.puml | 18 +++++++++ 6 files changed, 94 insertions(+), 12 deletions(-) create mode 100644 projects/local_transceiver/diagrams/inbound_sequence.puml create mode 100644 projects/local_transceiver/diagrams/outbound_sequence.puml create mode 100644 projects/local_transceiver/diagrams/participants.puml diff --git a/projects/can_transceiver/diagrams/common_sequence.puml b/projects/can_transceiver/diagrams/common_sequence.puml index 4b3eabf..aaf7135 100644 --- a/projects/can_transceiver/diagrams/common_sequence.puml +++ b/projects/can_transceiver/diagrams/common_sequence.puml @@ -1,18 +1,11 @@ @startuml Common Sequence title Common Sequence -!startsub PARTICIPANTS -' TODO: Move parameters to a general template +!include %getenv("PLANTUML_TEMPLATE_PATH") + autonumber -!$MAX_MESSAGE_SIZE = 100 -skinparam { - BoxPadding 10 - MaxMessageSize $MAX_MESSAGE_SIZE - ParticipantPadding 20 - SequenceMessageAlign center - wrapWidth $MAX_MESSAGE_SIZE -} +!startsub PARTICIPANTS box "Common Sequence" participant CanTransceiver as can participant CanTransceiverRosIntf as ros_intf diff --git a/projects/can_transceiver/diagrams/deployment_sequence.puml b/projects/can_transceiver/diagrams/deployment_sequence.puml index 9096560..5b7a2b7 100644 --- a/projects/can_transceiver/diagrams/deployment_sequence.puml +++ b/projects/can_transceiver/diagrams/deployment_sequence.puml @@ -1,7 +1,10 @@ @startuml Deployment Sequence - title Deployment Sequence +!include %getenv("PLANTUML_TEMPLATE_PATH") + +autonumber + !includesub common_sequence.puml!PARTICIPANTS -> can : Sensors from ELEC [CAN] diff --git a/projects/can_transceiver/diagrams/simulation_sequence.puml b/projects/can_transceiver/diagrams/simulation_sequence.puml index da44e3d..824a00a 100644 --- a/projects/can_transceiver/diagrams/simulation_sequence.puml +++ b/projects/can_transceiver/diagrams/simulation_sequence.puml @@ -1,7 +1,10 @@ @startuml Simulation Sequence - title Simulation Sequence +!include %getenv("PLANTUML_TEMPLATE_PATH") + +autonumber + box "Simulation Sequence" participant CanSimIntf as sim_intf participant CanSimTransceiver as sim_t diff --git a/projects/local_transceiver/diagrams/inbound_sequence.puml b/projects/local_transceiver/diagrams/inbound_sequence.puml new file mode 100644 index 0000000..f393b15 --- /dev/null +++ b/projects/local_transceiver/diagrams/inbound_sequence.puml @@ -0,0 +1,25 @@ +@startuml Inbound Sequence +title Inbound Sequence + +!include %getenv("PLANTUML_TEMPLATE_PATH") +!include participants.puml + + +autonumber + +== Update Global Waypoints Subsequence == + +note over buf : Unused + +intf -> intf ++ : Update Timer Triggers +intf -> local ++ : Get Global Waypoints +local -> local : Create Global Waypoints Object +loop While Iridium Mailbox is Not Empty &&\nThere are Global Waypoints Remaining + local --> port : Issue AT Read Command + local <-- port : Read response + local -> local : Update Global Waypoints Object +end +opt If New Global Waypoints + intf <- local -- : Return New Global Waypoints + <- intf -- : Publish Global Waypoints +end diff --git a/projects/local_transceiver/diagrams/outbound_sequence.puml b/projects/local_transceiver/diagrams/outbound_sequence.puml new file mode 100644 index 0000000..66d066a --- /dev/null +++ b/projects/local_transceiver/diagrams/outbound_sequence.puml @@ -0,0 +1,40 @@ +@startuml Outbound Sequence +title Outbound Sequence + +!include %getenv("PLANTUML_TEMPLATE_PATH") +!include participants.puml + +autonumber + +== Update Sensors Subsequence == + +note across : Very Frequent - On Demand Execution + +-> intf ++ : New Sensor Data +intf -> local ++ : Update Sensor +local -> local : Convert Data from ROS to Google Protobuf +local --> buf : Store Sensor in Buffer +deactivate intf +deactivate local + +... + +== Transmit Sensors Subsequence == + +note across : Very Infrequent - Execute Every Few Hours + +intf -> intf ++ : Transmit Timer Triggers +intf -> local ++ : Start Transmission +local <-- buf : Read Current Sensors +local -> local : Serialize Sensor Data +local -> local : Create AT Write Binary Command With Data +note right of local : If payload is too large, split the data across multiple commands +loop Until Successful or Unsuccessful Attempts + local --> port : Write Command + local <-- port : Read Response +end +opt If Failed to Transmit Sensors Data + intf <- local -- : Return failure + intf -> intf : Set Shorter Transmit Timer Interval +end +deactivate intf diff --git a/projects/local_transceiver/diagrams/participants.puml b/projects/local_transceiver/diagrams/participants.puml new file mode 100644 index 0000000..d7d0a17 --- /dev/null +++ b/projects/local_transceiver/diagrams/participants.puml @@ -0,0 +1,18 @@ +@startuml participants + +box Modules +participant "Local Transceiver ROS Intf" as intf +participant "Local Transceiver" as local +end box + +box Resources +Database "Sensor Buffer" as buf +Queue "Serial Port" as port +end box + +note across + As ROS is used for synchronizing our resources, the module control flow + is blocking, meaning only one subsequence can happen at at a time. +end note + +@enduml From 2f469920eb0ce53297e6bf1de15293ed4bd5a2f6 Mon Sep 17 00:00:00 2001 From: hhenry01 Date: Mon, 20 Nov 2023 17:54:22 -0800 Subject: [PATCH 3/6] Add Remote Transceiver Diagrams --- .../diagrams/common_sequence.puml | 2 +- .../diagrams/deployment_sequence.puml | 2 +- .../diagrams/simulation_sequence.puml | 2 +- .../local_transceiver/diagrams/common.puml | 18 ++++++++++ .../diagrams/inbound_sequence.puml | 5 ++- .../diagrams/outbound_sequence.puml | 4 +-- .../diagrams/participants.puml | 18 ---------- .../remote_transceiver/diagrams/common.puml | 15 ++++++++ .../diagrams/receive_sensors_sequence.puml | 35 +++++++++++++++++++ .../transmit_global_path_sequence.puml | 24 +++++++++++++ 10 files changed, 99 insertions(+), 26 deletions(-) create mode 100644 projects/local_transceiver/diagrams/common.puml delete mode 100644 projects/local_transceiver/diagrams/participants.puml create mode 100644 projects/remote_transceiver/diagrams/common.puml create mode 100644 projects/remote_transceiver/diagrams/receive_sensors_sequence.puml create mode 100644 projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml diff --git a/projects/can_transceiver/diagrams/common_sequence.puml b/projects/can_transceiver/diagrams/common_sequence.puml index aaf7135..d8aec37 100644 --- a/projects/can_transceiver/diagrams/common_sequence.puml +++ b/projects/can_transceiver/diagrams/common_sequence.puml @@ -1,5 +1,5 @@ @startuml Common Sequence -title Common Sequence +title Local Transceiver Common Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") diff --git a/projects/can_transceiver/diagrams/deployment_sequence.puml b/projects/can_transceiver/diagrams/deployment_sequence.puml index 5b7a2b7..e07543f 100644 --- a/projects/can_transceiver/diagrams/deployment_sequence.puml +++ b/projects/can_transceiver/diagrams/deployment_sequence.puml @@ -1,5 +1,5 @@ @startuml Deployment Sequence -title Deployment Sequence +title Local Transceiver Deployment Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") diff --git a/projects/can_transceiver/diagrams/simulation_sequence.puml b/projects/can_transceiver/diagrams/simulation_sequence.puml index 824a00a..fdca86d 100644 --- a/projects/can_transceiver/diagrams/simulation_sequence.puml +++ b/projects/can_transceiver/diagrams/simulation_sequence.puml @@ -1,5 +1,5 @@ @startuml Simulation Sequence -title Simulation Sequence +title Local Transceiver Simulation Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") diff --git a/projects/local_transceiver/diagrams/common.puml b/projects/local_transceiver/diagrams/common.puml new file mode 100644 index 0000000..39ef654 --- /dev/null +++ b/projects/local_transceiver/diagrams/common.puml @@ -0,0 +1,18 @@ +@startuml common + +box Modules +participant "Local Transceiver ROS Intf" as intf +participant "Local Transceiver" as local +end box + +box Resources +Collections "Sensor Buffer" as buf +Queue "Serial Port" as port +end box + +note across + As ROS is used for synchronizing access to resources, the module control + flow is blocking, meaning only one subsequence can happen at at a time. +end note + +@enduml diff --git a/projects/local_transceiver/diagrams/inbound_sequence.puml b/projects/local_transceiver/diagrams/inbound_sequence.puml index f393b15..580d8ea 100644 --- a/projects/local_transceiver/diagrams/inbound_sequence.puml +++ b/projects/local_transceiver/diagrams/inbound_sequence.puml @@ -1,9 +1,8 @@ @startuml Inbound Sequence -title Inbound Sequence +title Local Transceiver Inbound Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") -!include participants.puml - +!include common.puml autonumber diff --git a/projects/local_transceiver/diagrams/outbound_sequence.puml b/projects/local_transceiver/diagrams/outbound_sequence.puml index 66d066a..ce10283 100644 --- a/projects/local_transceiver/diagrams/outbound_sequence.puml +++ b/projects/local_transceiver/diagrams/outbound_sequence.puml @@ -1,8 +1,8 @@ @startuml Outbound Sequence -title Outbound Sequence +title Local Transceiver Outbound Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") -!include participants.puml +!include common.puml autonumber diff --git a/projects/local_transceiver/diagrams/participants.puml b/projects/local_transceiver/diagrams/participants.puml deleted file mode 100644 index d7d0a17..0000000 --- a/projects/local_transceiver/diagrams/participants.puml +++ /dev/null @@ -1,18 +0,0 @@ -@startuml participants - -box Modules -participant "Local Transceiver ROS Intf" as intf -participant "Local Transceiver" as local -end box - -box Resources -Database "Sensor Buffer" as buf -Queue "Serial Port" as port -end box - -note across - As ROS is used for synchronizing our resources, the module control flow - is blocking, meaning only one subsequence can happen at at a time. -end note - -@enduml diff --git a/projects/remote_transceiver/diagrams/common.puml b/projects/remote_transceiver/diagrams/common.puml new file mode 100644 index 0000000..292d8b8 --- /dev/null +++ b/projects/remote_transceiver/diagrams/common.puml @@ -0,0 +1,15 @@ +@startuml common + +box Modules +participant "HTTP Handler" as handler +participant "HTTP Server" as server +participant SailbotDB as db +end box + +note over handler, server + Part of the same class. The handler is separated from the + server in the diagram to illustrate that the server does + not block on requests, and multiple can be handled simultaneously. +end note + +@endmul diff --git a/projects/remote_transceiver/diagrams/receive_sensors_sequence.puml b/projects/remote_transceiver/diagrams/receive_sensors_sequence.puml new file mode 100644 index 0000000..5428bd2 --- /dev/null +++ b/projects/remote_transceiver/diagrams/receive_sensors_sequence.puml @@ -0,0 +1,35 @@ +@startuml Receive Sensors Sequence +title Remote Transceiver Receive Sensors Sequence + +!include %getenv("PLANTUML_TEMPLATE_PATH") +!include common.puml + +autonumber + +box Resources +Collections "Sensors Buffer" as buf +Database "MongoDB" as mongo +end box + +note over buf : Contents of this buffer are \nunparsed, raw binary strings + +-> handler ++ : POST Sensors +handler -> server --++: Process POST Request +server -> server : Parse HTTP +server --> buf : Update Sensors Buffer +alt If Incomplete Sensors Payload + handler <- server --++ : Return OK + <- handler -- : Send Response + +else Else All Sensor Payloads Received + activate server + handler <-- server ++ : Return OK + note right of server : Execution continues after returning HTTP response + <- handler -- : Send Response + server <-- buf : Read Entire Buffer + server -> server : Parse Protobuf Sensors Object from Binary + server -> db ++ : Commit Sensors to DB + db -> db : Convert Sensors to BSON Format + db --> mongo -- : Write Sensors to MongoDB + deactivate server +end diff --git a/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml b/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml new file mode 100644 index 0000000..b4ee88e --- /dev/null +++ b/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml @@ -0,0 +1,24 @@ +@startuml Transmit Global Path Sequence +title Remote Transceiver Transmit Global Path Sequence + +!include %getenv("PLANTUML_TEMPLATE_PATH") +!include common.puml + +autonumber + +note over db : Unused + +-> handler ++ : POST Global Path +handler -> server --++ : Process POST request +server -> server : Parse HTTP Request for Waypoints +server -> server : Convert Waypoints to Protobuf and Serialize +opt If Waypoints are too Large for One Message + server -> server : Split Waypoints Across Multiples Messages +end +loop For Each Waypoint Message + server --> handler ++ : Transmit Waypoints + <- handler -- : POST Waypoints to Iridium + deactivate server +end + +@enduml From 830bb5f16400b7468eda631adb2a6780dfbc3ad8 Mon Sep 17 00:00:00 2001 From: hhenry01 Date: Tue, 21 Nov 2023 09:24:23 -0800 Subject: [PATCH 4/6] Update Remote Transceiver Diagram --- .../diagrams/transmit_global_path_sequence.puml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml b/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml index b4ee88e..6618840 100644 --- a/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml +++ b/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml @@ -18,7 +18,11 @@ end loop For Each Waypoint Message server --> handler ++ : Transmit Waypoints <- handler -- : POST Waypoints to Iridium - deactivate server + note over handler, server + To prevent out of order transmissions, POSTING + to Iridium should be a blocking operation. + end note end +deactivate server @enduml From 87833ff7341d3d4600c657780869ca73cf0cb83a Mon Sep 17 00:00:00 2001 From: hhenry01 Date: Wed, 22 Nov 2023 12:21:10 -0800 Subject: [PATCH 5/6] Clarify global path transmit sequence --- .../diagrams/transmit_global_path_sequence.puml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml b/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml index 6618840..cb875f0 100644 --- a/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml +++ b/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml @@ -16,11 +16,13 @@ opt If Waypoints are too Large for One Message server -> server : Split Waypoints Across Multiples Messages end loop For Each Waypoint Message - server --> handler ++ : Transmit Waypoints - <- handler -- : POST Waypoints to Iridium + server -> handler ++ : Transmit Waypoints + <-- handler : POST Waypoints to Iridium + handler -> server -- : POST complete note over handler, server - To prevent out of order transmissions, POSTING - to Iridium should be a blocking operation. + To prevent out of order transmissions on random + POST failures, POSTING to Iridium should be a + blocking operation. end note end deactivate server From 6d9b3598dd0c34c0954d5168d7d98ffade557aff Mon Sep 17 00:00:00 2001 From: hhenry01 Date: Wed, 22 Nov 2023 15:54:15 -0800 Subject: [PATCH 6/6] Make diagram exporting cleaner --- .gitignore | 5 ++++- projects/can_transceiver/diagrams/common_sequence.puml | 2 +- projects/can_transceiver/diagrams/deployment_sequence.puml | 2 +- projects/can_transceiver/diagrams/simulation_sequence.puml | 2 +- projects/local_transceiver/diagrams/common.puml | 1 + ...bound_sequence.puml => receive_global_path_sequence.puml} | 4 ++-- ...outbound_sequence.puml => transmit_sensors_sequence.puml} | 4 ++-- projects/remote_transceiver/diagrams/common.puml | 1 + .../diagrams/receive_sensors_sequence.puml | 2 +- .../diagrams/transmit_global_path_sequence.puml | 2 +- 10 files changed, 15 insertions(+), 10 deletions(-) rename projects/local_transceiver/diagrams/{inbound_sequence.puml => receive_global_path_sequence.puml} (86%) rename projects/local_transceiver/diagrams/{outbound_sequence.puml => transmit_sensors_sequence.puml} (92%) diff --git a/.gitignore b/.gitignore index a8a6e51..ec6f810 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ # autogenerated files -lib/cmn_hdrs/ros_info.h +/lib/cmn_hdrs/ros_info.h *.pyc + +# PlantUML diagram export directory +/diagrams/out/ diff --git a/projects/can_transceiver/diagrams/common_sequence.puml b/projects/can_transceiver/diagrams/common_sequence.puml index d8aec37..95bca74 100644 --- a/projects/can_transceiver/diagrams/common_sequence.puml +++ b/projects/can_transceiver/diagrams/common_sequence.puml @@ -1,4 +1,4 @@ -@startuml Common Sequence +@startuml common_sequence title Local Transceiver Common Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") diff --git a/projects/can_transceiver/diagrams/deployment_sequence.puml b/projects/can_transceiver/diagrams/deployment_sequence.puml index e07543f..f1d9174 100644 --- a/projects/can_transceiver/diagrams/deployment_sequence.puml +++ b/projects/can_transceiver/diagrams/deployment_sequence.puml @@ -1,4 +1,4 @@ -@startuml Deployment Sequence +@startuml deployment_sequence title Local Transceiver Deployment Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") diff --git a/projects/can_transceiver/diagrams/simulation_sequence.puml b/projects/can_transceiver/diagrams/simulation_sequence.puml index fdca86d..43578fb 100644 --- a/projects/can_transceiver/diagrams/simulation_sequence.puml +++ b/projects/can_transceiver/diagrams/simulation_sequence.puml @@ -1,4 +1,4 @@ -@startuml Simulation Sequence +@startuml simulation_sequence title Local Transceiver Simulation Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") diff --git a/projects/local_transceiver/diagrams/common.puml b/projects/local_transceiver/diagrams/common.puml index 39ef654..63c2147 100644 --- a/projects/local_transceiver/diagrams/common.puml +++ b/projects/local_transceiver/diagrams/common.puml @@ -1,3 +1,4 @@ +' To be included by other files. Do not use on its own. @startuml common box Modules diff --git a/projects/local_transceiver/diagrams/inbound_sequence.puml b/projects/local_transceiver/diagrams/receive_global_path_sequence.puml similarity index 86% rename from projects/local_transceiver/diagrams/inbound_sequence.puml rename to projects/local_transceiver/diagrams/receive_global_path_sequence.puml index 580d8ea..e5a672f 100644 --- a/projects/local_transceiver/diagrams/inbound_sequence.puml +++ b/projects/local_transceiver/diagrams/receive_global_path_sequence.puml @@ -1,5 +1,5 @@ -@startuml Inbound Sequence -title Local Transceiver Inbound Sequence +@startuml receive_global_path_sequence +title Local Transceiver Receive Global Path Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") !include common.puml diff --git a/projects/local_transceiver/diagrams/outbound_sequence.puml b/projects/local_transceiver/diagrams/transmit_sensors_sequence.puml similarity index 92% rename from projects/local_transceiver/diagrams/outbound_sequence.puml rename to projects/local_transceiver/diagrams/transmit_sensors_sequence.puml index ce10283..c0fc227 100644 --- a/projects/local_transceiver/diagrams/outbound_sequence.puml +++ b/projects/local_transceiver/diagrams/transmit_sensors_sequence.puml @@ -1,5 +1,5 @@ -@startuml Outbound Sequence -title Local Transceiver Outbound Sequence +@startuml transmit_sensors_sequence +title Local Transceiver Transmit Sensors Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") !include common.puml diff --git a/projects/remote_transceiver/diagrams/common.puml b/projects/remote_transceiver/diagrams/common.puml index 292d8b8..ee3c27d 100644 --- a/projects/remote_transceiver/diagrams/common.puml +++ b/projects/remote_transceiver/diagrams/common.puml @@ -1,3 +1,4 @@ +' To be included in other files, do not use on its own @startuml common box Modules diff --git a/projects/remote_transceiver/diagrams/receive_sensors_sequence.puml b/projects/remote_transceiver/diagrams/receive_sensors_sequence.puml index 5428bd2..780fe79 100644 --- a/projects/remote_transceiver/diagrams/receive_sensors_sequence.puml +++ b/projects/remote_transceiver/diagrams/receive_sensors_sequence.puml @@ -1,4 +1,4 @@ -@startuml Receive Sensors Sequence +@startuml receive_sensors_sequence title Remote Transceiver Receive Sensors Sequence !include %getenv("PLANTUML_TEMPLATE_PATH") diff --git a/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml b/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml index cb875f0..f8d1bb8 100644 --- a/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml +++ b/projects/remote_transceiver/diagrams/transmit_global_path_sequence.puml @@ -1,4 +1,4 @@ -@startuml Transmit Global Path Sequence +@startuml transmit_global_path_sequence title Remote Transceiver Transmit Global Path Sequence !include %getenv("PLANTUML_TEMPLATE_PATH")