native libraries block (#1642)

This commit is contained in:
pdxlocations 2025-01-01 11:15:58 -08:00 committed by GitHub
parent b2e167c2b9
commit b370396ed5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 16 additions and 9 deletions

View file

@ -0,0 +1,9 @@
- Necessary system libraries should be installed before building or installing Meshtasticd.
```shell
sudo apt install libgpiod-dev libyaml-cpp-dev libbluetooth-dev libusb-1.0-0-dev libi2c-dev
```
- And optionally for web server support
```shell
sudo apt install openssl libssl-dev libulfius-dev liborcania-dev
```

View file

@ -6,6 +6,8 @@ sidebar_position: 11
description: Set up and configure Meshtastic on Linux-native devices using the meshtasticd binary.
---
import NativeLibraries from "@site/docs/blocks/_native-libraries.mdx";
This page outlines the setup of Meshtastic on Linux-native devices, utilizing portduino to run the Meshtastic firmware under Linux.
## Prerequisites and Hardware Compatibility
@ -37,15 +39,7 @@ UART HATs and SX1302/SX1303 chip-based HATs are not supported. Only hats that us
### Installing Meshtasticd
- Necessary system libraries should be installed before building or installing Meshtastic.
```shell
sudo apt install libgpiod-dev libyaml-cpp-dev libbluetooth-dev libusb-1.0-0-dev libi2c-dev
```
- And optionally for web server support
```shell
sudo apt install openssl libssl-dev libulfius-dev liborcania-dev
```
<NativeLibraries />
- The .deb Package is available as [part of the release](https://github.com/meshtastic/firmware/releases/latest), installing the binary, a systemd service, and a config file. It is compiled for Debian Bookworm and incompatible with Bullseye.
```shell

View file

@ -5,6 +5,8 @@ sidebar_label: Linux Native
sidebar_position: 5
---
import NativeLibraries from "@site/docs/blocks/_native-libraries.mdx";
The device software can also run on a native Linux machine thanks to the [Portduino framework](https://github.com/geeksville/framework-portduino).
The application either simulates some of the interfaces, or uses the real hardware of your machine.
@ -17,6 +19,8 @@ For instructions on how to use it, see the [interactive simulator](https://githu
The easiest way of building the native application is using Visual Studio Code with the PlatformIO extension.
See the instructions for creating such a building environment [here](/docs/development/firmware/build).
<NativeLibraries />
Then after opening the firmware repository in Visual Studio Code, simply click on the PlatformIO extension in the left bar, select native and click on 'Build'.
This will generate the binary file 'program' which you can find in `.pio/build/native/`.
Once in this directory or when you copied the file to your current directory, launch the application with `./program`.