Skip to content

Commit

Permalink
fmt
Browse files Browse the repository at this point in the history
  • Loading branch information
JarbasAl committed Dec 22, 2024
1 parent a2635c4 commit 2d864aa
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions docs/04_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ See [hivemind-persona](https://github.com/JarbasHiveMind/hivemind-persona) for a
- Authorized messages are injected into the master's OVOS-core bus.
- Direct responses from the master's OVOS-core are forwarded back to the originating slave.

> 💡 Valid payloads for OVOS can be found [here](https://github.com/OpenVoiceOS/message_spec)
**Command Line**:

```bash
$ hivemind-client send-mycroft --help
Expand All @@ -80,12 +80,12 @@ Options:
--help Show this message and exit.
```

> 💡 Valid payloads for OVOS can be found [here](https://github.com/OpenVoiceOS/message_spec)
**Visualization**:

![BUS Message Flow](https://raw.githubusercontent.com/JarbasHiveMind/HiveMind-core/dev/resources/bus.gif)

**Use Case**: Terminal applications (e.g., voice-sat) inject natural language queries. Other integrations (e.g., Home
Assistant) may inject specific messages based on their configuration.

### SHARED_BUS Message

Expand Down Expand Up @@ -152,17 +152,12 @@ for [Nested Hives](https://jarbashivemind.github.io/HiveMind-community-docs/15_n
- **Behavior**:
- Elevates messages up the authority chain for higher-level processing.


**Example**: Escalate a OVOS message:

```bash
$ hivemind-client escalate --msg "intent_failure" --payload "{}"
```

**Visualization**:

![Escalate Message Flow](https://raw.githubusercontent.com/JarbasHiveMind/HiveMind-core/dev/resources/escalate.gif)

**Command Line**:

```bash
$ hivemind-client escalate --help
Usage: hivemind-client escalate [OPTIONS]
Expand Down Expand Up @@ -192,6 +187,8 @@ Options:

![Propagate Message Flow](https://raw.githubusercontent.com/JarbasHiveMind/HiveMind-core/dev/resources/propagate.gif)

**Command Line**:

```bash
$ hivemind-client propagate --help
Usage: hivemind-client propagate [OPTIONS]
Expand Down

0 comments on commit 2d864aa

Please sign in to comment.