Skip to content

Commit 199c4fe

Browse files
authored
Add HRL Support (#10)
* Fixed issue with readme * Integrate HRL Support (#8) * Added missing type hints * Refactored to cleanup message sending and added support to send msg until ack * Added support for new HRL messages * Updated devices to use tuple key and ensure msg target in network * Added requirement to clone repo in readme * Resolved grammatical error * Updated readme to reflect require_ack change * Updated python requirement in readme and updated setup version * Resolved errors in structuring named value int message * Cleaned up readme formatting * Created dependencies section in readme
1 parent 70e886b commit 199c4fe

File tree

6 files changed

+301
-208
lines changed

6 files changed

+301
-208
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@
33
## Introduction
44
`pymavswarm` is a Python library implemented to enable interaction with robotic swarms using the MAVLink protocol. This library supports reading MAVLink messages sent from multiple agents in a swarm and sending MAVLink messages to agents within the swarm. Such functionality ultimately enables development of new swarm applications such as ground control stations.
55

6+
## Dependencies
7+
`pymavswarm` depends on Python versions 3.9 or greater. Ensure that this dependency is met prior to installation.
68

79
## Installation
810
`pymavswarm` must currently be installed manually. To do so, refer to the steps below:
9-
1. Navigate to the `pymavswarm/` repository directory
11+
1. Clone this repository
12+
2. Navigate to the `pymavswarm/` repository directory
1013
```bash
1114
cd path/to/pymavswarm/
1215
```
13-
2. Install the `pymavswarm` Python package
16+
3. Install the `pymavswarm` Python package
1417
```bash
1518
pip3 install .
1619
```
@@ -33,8 +36,8 @@ msgs = []
3336
# Send an arming message to Agent (2, 1)
3437
msgs.append(OutgoingMsg(MsgMap().system_commands.arm, 2, 1))
3538

36-
# Send the desired messages and check for message acknowledgement
37-
mavswarm.send_msg(msgs, ack=True)
39+
# Send the desired messages and require that the messages be acknowledged
40+
mavswarm.send_msg(msgs, require_ack=True)
3841

3942
# Read the current state of the swarm agents
4043
for agent in mavswarm.get_agents():
@@ -45,4 +48,4 @@ mavswarm.disconnect()
4548
```
4649

4750
## License
48-
pymavswarm is released under the GNU General Public License v3 or later
51+
`pymavswarm` is released under the GNU General Public License v3 or later

0 commit comments

Comments
 (0)