Skip to content

Commit

Permalink
Merge branch 'fix/doc_diagrams' into 'main'
Browse files Browse the repository at this point in the history 
fix(doc_diagrams) Fixed colours in Mermaid diagrams

See merge request app-frameworks/esp_hosted_mcu!23
  • Loading branch information
@mantriyogesh
mantriyogesh committed Jan 31, 2025
2 parents d4949c7 + 5fc0980 commit 9ff3696
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 33 deletions.
48 changes: 24 additions & 24 deletions docs/bluetooth_design.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,13 @@ on both the Hosted Master and co-processor.

```mermaid
sequenceDiagram
box Grey Hosted Master
box rgb(128, 128, 128) Hosted Master
participant ble as NimBLE Host Bluetooth Stack
participant vhci as VHCI Driver
participant master as SPI/SDIO Interface
end
box Grey Hosted Co-processor
box rgb(128, 128, 128) Hosted Co-processor
participant sinterface as SPI/SDIO Interface
participant slave as Bluetooth Controller
end
Expand All @@ -174,13 +174,13 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Hosted Master
box rgb(128, 128, 128) Hosted Master
participant ble as NimBLE Host Bluetooth Stack
participant vhci as VHCI Driver
participant master as SPI/SDIO Interface
end
box Grey Hosted Co-processor
box rgb(128, 128, 128) Hosted Co-processor
participant sinterface as SPI/SDIO Interface
participant slave as Bluetooth Controller
end
Expand All @@ -204,13 +204,13 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Hosted Master
box rgb(128, 128, 128) Hosted Master
participant ble as NimBLE Host Bluetooth Stack
participant vhci as VHCI Driver
participant master as SPI/SDIO Interface
end
box Grey Hosted Co-processor
box rgb(128, 128, 128) Hosted Co-processor
participant sinterface as SPI/SDIO Interface
participant slave as Bluetooth Controller
end
Expand Down Expand Up @@ -244,12 +244,12 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Master
box rgb(128, 128, 128) Master
participant ble as NimBLE Host Bluetooth Stack
participant huart as UART Driver
end
box Grey Co-processor
box rgb(128, 128, 128) Co-processor
participant slave as Bluetooth Controller with UART Interface
end
Expand All @@ -268,12 +268,12 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Master
box rgb(128, 128, 128) Master
participant ble as NimBLE Host Bluetooth Stack
participant huart as UART Driver
end
box Grey Co-processor
box rgb(128, 128, 128) Co-processor
participant slave as Bluetooth Controller with UART Interface
end
Expand All @@ -290,12 +290,12 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Master
box rgb(128, 128, 128) Master
participant ble as NimBLE Host Bluetooth Stack
participant huart as UART Driver
end
box Grey Co-processor
box rgb(128, 128, 128) Co-processor
participant slave as Bluetooth Controller with UART Interface
end
Expand Down Expand Up @@ -342,13 +342,13 @@ on both the Hosted Master and Co-processor.

```mermaid
sequenceDiagram
box Grey Hosted Master
box rgb(128, 128, 128) Hosted Master
participant bt as Host Application
participant vhci as VHCI Driver
participant master as SPI/SDIO Interface
end
box Grey Hosted Co-processor
box rgb(128, 128, 128) Hosted Co-processor
participant sinterface as SPI/SDIO Interface
participant slave as Bluetooth Controller
end
Expand All @@ -364,13 +364,13 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Hosted Master
box rgb(128, 128, 128) Hosted Master
participant bt as BlueDroid Host Bluetooth Stack
participant vhci as VHCI Driver
participant master as SPI/SDIO Interface
end
box Grey Hosted Co-processor
box rgb(128, 128, 128) Hosted Co-processor
participant sinterface as SPI/SDIO Interface
participant slave as Bluetooth Controller
end
Expand All @@ -394,13 +394,13 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Hosted Master
box rgb(128, 128, 128) Hosted Master
participant bt as BlueDroid Host Bluetooth Stack
participant vhci as VHCI Driver
participant master as SPI/SDIO Interface
end
box Grey Hosted Co-processor
box rgb(128, 128, 128) Hosted Co-processor
participant sinterface as SPI/SDIO Interface
participant slave as Bluetooth Controller
end
Expand Down Expand Up @@ -438,12 +438,12 @@ that do the following are required:

```mermaid
sequenceDiagram
box Grey Master
box rgb(128, 128, 128) Master
participant bt as Host Application
participant huart as UART Driver
end
box Grey Co-processor
box rgb(128, 128, 128) Co-processor
participant slave as Bluetooth Controller with UART Interface
end
Expand All @@ -458,12 +458,12 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Master
box rgb(128, 128, 128) Master
participant bt as BlueDroid Host Bluetooth Stack
participant huart as UART Driver
end
box Grey Co-processor
box rgb(128, 128, 128) Co-processor
participant slave as Bluetooth Controller with UART Interface
end
Expand All @@ -479,12 +479,12 @@ sequenceDiagram

```mermaid
sequenceDiagram
box Grey Master
box rgb(128, 128, 128) Master
participant bt as BlueDroid Host Bluetooth Stack
participant huart as UART Driver
end
box Grey Co-processor
box rgb(128, 128, 128) Co-processor
participant slave as Bluetooth Controller with UART Interface
end
Expand Down
14 changes: 5 additions & 9 deletions docs/wifi_design.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ response is returned to the application.

```mermaid
sequenceDiagram
box Grey Host With Native WI-Fi
box rgb(128, 128, 128) Host With Native WI-Fi
participant app as Application
participant api as ESP-IDF Wi-Fi Library
participant wifi as Wi-Fi Hardware
Expand All @@ -35,14 +35,14 @@ encapsulates the data for transport.

```mermaid
sequenceDiagram
box Grey Host with ESP-Hosted
box rgb(128, 128, 128) Host with ESP-Hosted
participant app as Application
participant remote as Wi-Fi Remote
participant hostedh as ESP-Hosted
participant transporth as Host Transport
end
box SlateGrey Slave ESP-Hosted
box rgb(128, 128, 128) Slave ESP-Hosted
participant transports as Slave Transport
participant hosteds as Slave Hosted
participant api as ESP-IDF Wi-Fi Library
Expand All @@ -60,11 +60,11 @@ sequenceDiagram
transports ->> hosteds :
Note over hosteds : remove Hosted header
hosteds ->> api : esp_wifi_xxx()
api ->> wifi : Wi-Fi command
hosteds ->> wifi : Network Data
api ->> wifi : Wi-Fi command or Data
Note over wifi: Do Wi-Fi action
wifi -->> api : Wi-Fi response or Data
wifi -->> hosteds : Network Data
wifi -->> api : Wi-Fi response
api -->> hosteds : Response
Note over hosteds : add Hosted header
hosteds -->> transports :
Expand All @@ -77,7 +77,3 @@ sequenceDiagram
hostedh -->> remote : Wi-Fi Command response
remote -->> app : Response
```




0 comments on commit 9ff3696

Please sign in to comment.