mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-21 03:25:51 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feedback

Browse source
This commit is contained in:
rcarteraz 2024-10-16 12:21:49 -07:00
parent 6abec896cf
commit ffe031e553
2 changed files with 22 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/software/meshtasticator/discrete-event-sim.mdx
View file

@ -3,7 +3,7 @@ id: discrete-event-sim
title: Discrete Event Simulator Usage Guide
sidebar_label: Discrete Event Simulator
sidebar_position: 1
description: Discrete Event Simulator usage guide, simulating radio communications with configurable parameters and node behaviors.
description: A usage guide for simulating radio communications with configurable parameters and node behaviors.
---
The discrete-event simulator mimics the radio section of the device software. It is currently based on Meshtastic 2.1.

38
docs/software/meshtasticator/interactive-sim.mdx
View file

@ -3,7 +3,7 @@ id: interactive-sim
title: Interactive Simulator Usage Guide
sidebar_label: Interactive Event Simulator
sidebar_position: 2
description: Interactive Simulator usage guide for simulating multiple Meshtastic instances with TCP-based communication and configurable pathloss models.
description: A usage guide for simulating multiple Meshtastic instances with TCP-based communication and configurable pathloss models.
---
The Python script _`interactiveSim.py`_ uses the [Linux native application of Meshtastic](https://meshtastic.org/docs/software/linux-native) to simulate multiple instances of the device software. These instances communicate using TCP via the script, simulating the LoRa chip. The simulator forwards messages from the sender to all nodes within range, based on their simulated positions and the selected pathloss model (see [Pathloss Model](#pathloss-model)). **Note:** Packet collisions are not yet simulated.
@ -20,27 +20,31 @@ The Python script _`interactiveSim.py`_ uses the [Linux native application of Me
The simulator runs the Linux native application of Meshtastic firmware. You can use either [PlatformIO](https://meshtastic.org/docs/development/firmware/build) or [Docker](https://meshtastic.org/docs/software/linux-native#usage-with-docker) to run the firmware:
- **Using PlatformIO:**
Select 'native' and click 'build.' Locate the generated binary file, likely in `_Meshtastic-device/.pio/build/native/_`.
Copy the `program` file to the directory where you'll run the Python script, or provide the path as an argument with `-p`:
### Using PlatformIO
```bash
python3 interactiveSim.py 3 -p /home/User/Meshtastic-device/.pio/build/native/program
```
Select 'native' and click 'build.' Locate the generated binary file, likely in `_Meshtastic-device/.pio/build/native/_`.
- **Using Docker:**
The simulator pulls a Docker image that builds the latest Meshtastic firmware.
Ensure the Docker SDK for Python is installed:
Copy the `program` file to the directory where you'll run the Python script, or provide the path as an argument with `-p`:
```bash
pip3 install docker
```
```bash
python3 interactiveSim.py 3 -p /home/User/Meshtastic-device/.pio/build/native/program
```
Make sure the Docker daemon or Desktop app is running. Use the `-d` argument to launch the simulator:
### Using Docker
```bash
python3 interactiveSim.py 3 -d
```
The simulator pulls a Docker image that builds the latest Meshtastic firmware.
Ensure the Docker SDK for Python is installed:
```bash
pip3 install docker
```
Make sure the Docker daemon or Desktop app is running. Use the `-d` argument to launch the simulator:
```bash
python3 interactiveSim.py 3 -d
```
## Running the Simulator