mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-19 23:57:31 -07:00
offloaded protodoc gerneration from ci to local process
This commit is contained in:
sigmahour
parent
933197b133
commit
a7b709e98e
24
.github/workflows/ci.yml
vendored
24
.github/workflows/ci.yml
vendored
|
|
@ -13,22 +13,22 @@ jobs:
|
|||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Install Go
|
||||
uses: actions/setup-go@v3
|
||||
with:
|
||||
go-version: 1.19
|
||||
- name: Install Protoc
|
||||
uses: arduino/setup-protoc@v1
|
||||
with:
|
||||
version: '3.x'
|
||||
- name: Install protoc-gen-doc
|
||||
run: go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v3
|
||||
with:
|
||||
submodules: true
|
||||
- name: Generate protobuf docs
|
||||
run: protoc --doc_out="docs/developers/Protobufs" --doc_opt="./protobuf.tmpl,api.mdx" --proto_path="protobufs" protobufs/*.proto
|
||||
#- name: Install Go
|
||||
# uses: actions/setup-go@v3
|
||||
# with:
|
||||
# go-version: 1.19
|
||||
#- name: Install Protoc
|
||||
# uses: arduino/setup-protoc@v1
|
||||
# with:
|
||||
# version: '3.x'
|
||||
#- name: Install protoc-gen-doc
|
||||
# run: go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
|
||||
#- name: Generate protobuf docs
|
||||
# run: protoc --doc_out="docs/developers/Protobufs" --doc_opt="./protobuf.tmpl,api.mdx" --proto_path="protobufs" protobufs/*.proto
|
||||
- uses: amondnet/vercel-action@v20
|
||||
with:
|
||||
vercel-token: ${{ secrets.VERCEL_TOKEN }}
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -8,9 +8,7 @@ sidebar_position: 1
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## Install USB to Serial Drivers
|
||||
|
||||
### ESP32 Drivers
|
||||
## Install ESP32 USB to Serial Drivers
|
||||
|
||||
You may need to install a driver from Silicon Labs for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
|
|
|
|||
|
|
@ -8,9 +8,11 @@ sidebar_position: 2
|
|||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## Install USB to Serial Drivers
|
||||
:::important
|
||||
Reboot your computer after you have installed the driver to complete the installation.
|
||||
:::
|
||||
|
||||
### NRF52 Drivers
|
||||
## Install NRF52 USB to Serial Drivers
|
||||
|
||||
<Tabs
|
||||
groupId="operating-system"
|
||||
|
|
@ -31,31 +33,6 @@ values={[
|
|||
|
||||
- [CH9102 Driver - MacOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
|
||||
|
||||
:::caution
|
||||
With the latest versions of MacOS, the USB Serial driver is built-in. Do _NOT_ download the USB device drivers unless required. If you downloaded/installed any already, please remove them:
|
||||
|
||||
<details>
|
||||
<summary>Removing the CH34x (CH340/CH341) USB Drivers</summary>
|
||||
<div>
|
||||
<div>
|
||||
If you have already downloaded/installed the MacOS WCH-IC CH340
|
||||
("CH341SER_MAC") drivers via the CH34x_Install_V1.5.pkg, you will have to
|
||||
Uninstall the kernel extension:
|
||||
<br />
|
||||
<br />
|
||||
1. Unplug your device
|
||||
<br />
|
||||
2. Open the Terminal and run:
|
||||
<br />
|
||||
3. sudo rm -rf /Library/Extensions/usbserial.kext
|
||||
<br />
|
||||
4. Reboot
|
||||
</div>
|
||||
</div>
|
||||
</details>
|
||||
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
|
||||
<TabItem value="windows">
|
||||
|
|
@ -66,6 +43,19 @@ With the latest versions of MacOS, the USB Serial driver is built-in. Do _NOT_ d
|
|||
|
||||
</Tabs>
|
||||
|
||||
:::important
|
||||
Reboot your computer after you have installed the driver to complete the installation.
|
||||
:::
|
||||
## Remove the CH34x USB Driver (macOS)
|
||||
|
||||
:::caution
|
||||
With the latest versions of MacOS, the USB Serial driver is built-in. Do _NOT_ download the USB device drivers unless required. If you downloaded/installed any already, please remove them:
|
||||
:::
|
||||
|
||||
If you have already downloaded/installed the MacOS WCH-IC CH340/CH341
|
||||
("CH341SER_MAC") drivers via the CH34x_Install_V1.5.pkg, you will have to
|
||||
Uninstall the kernel extension:
|
||||
|
||||
1. Unplug your device
|
||||
2. Open the Terminal and run:
|
||||
3. `sudo rm -rf /Library/Extensions/usbserial.kext`
|
||||
4. Reboot
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,4 @@
|
|||
|
||||
position: 1 # float position is supported
|
||||
position: 3 # float position is supported
|
||||
label: 'Hardware'
|
||||
collapsible: true # make the category collapsible
|
||||
link:
|
||||
|
|
|
|||
|
|
@ -1,18 +1,36 @@
|
|||
---
|
||||
id: android-installation
|
||||
title: Android application installation
|
||||
title: Android Application Installation
|
||||
sidebar_label: Android App
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
## Installation Methods
|
||||
|
||||
Our Android application is available on our F-Droid repo and Google Play Store. This allows you to connect to your Meshtastic device from your Android phone.
|
||||
|
||||
The minimum Android version is 5.0 (Lollipop 2014, first BLE support), however Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable.
|
||||
|
||||
### Install with F-Droid
|
||||
|
||||
<p float="center">
|
||||
<a href="https://mesh.tastic.app/fdroid/repo">
|
||||
<img alt="Get it on F-Droid"
|
||||
src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
|
||||
width="49%"/>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
1. Download and Install the F-Droid app from [f-droid.org](https://f-droid.org/)
|
||||
2. Open the F-Droid app and navigate to `Settings > Repositories`.
|
||||
3. Click on the `+` icon to add a new repo.
|
||||
3. Enter the Meshtastic repo address as follows: `https://mesh.tastic.app/fdroid/repo/` (no fingerprint required)
|
||||
4. Navigate to the `Categories` page and refresh (scroll down).
|
||||
5. Search for and install the `Meshtastic` App.
|
||||
|
||||
### Install from Play Store
|
||||
|
||||
<p float="center">
|
||||
<a href="https://play.google.com/store/apps/details?id=com.geeksville.mesh">
|
||||
<img alt="Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh"
|
||||
src="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
|
||||
|
|
@ -20,16 +38,14 @@ Our Android application is available on our F-Droid repo and Google Play Store.
|
|||
</a>
|
||||
</p>
|
||||
|
||||
The minimum Android version is 5.0 (Lollipop 2014, first BLE support), however Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable.
|
||||
There is a Play Store [testing program](https://play.google.com/apps/testing/com.geeksville.mesh) with the latest cutting edge changes, though this may come with extra bugs.
|
||||
|
||||
There is a Play Store [testing program](https://play.google.com/apps/testing/com.geeksville.mesh) with the latest cutting edge changes, though this may come with extra bugs. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to join.
|
||||
It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to join.
|
||||
|
||||
The app can also be sideloaded by downloading the .APK from <a href="https://github.com/meshtastic/Meshtastic-Android/releases/latest">GitHub releases</a> page. If you do sideload, you may have to give your browser permissions to run a package installer. If you wish to view the code or contribute to development of the app, please visit the app's <a href="https://github.com/meshtastic/Meshtastic-Android">GitHub page</a>.
|
||||
_Google Play and the Google Play logo are trademarks of Google LLC._
|
||||
|
||||
[](/img/android/android-messages-sm.png) [](/img/android/android-nodes.png) [](/img/android/android-channel.png) [](/img/android/android-settings.png) [](/img/android/android-debug.png)
|
||||
### Install by Sideloading
|
||||
|
||||
The app uses anonymous usage statistics and crash reports to allow us to catch problems with Meshtastic and fix them. You can disable this by unticking the checkbox on the settings page.
|
||||
The app can also be sideloaded by downloading the .APK from the [Github Releases](https://github.com/meshtastic/Meshtastic-Android/releases/latest) page.
|
||||
|
||||
[](/img/android/android-stats-consent.png)
|
||||
|
||||
Google Play and the Google Play logo are trademarks of Google LLC.
|
||||
If you do sideload, you may have to give your browser permissions to run a package installer. If you wish to view the code or contribute to development of the app, please visit the app's [GitHub page](https://github.com/meshtastic/Meshtastic-Android)
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit 46bc0afe050a836b6ec8b235c3ff55e9e037efcb
|
||||
Subproject commit ed9f2499d692925461facd64c6af2d2a7672245a
|
||||
24
scripts/gen-proto-docs.sh
Executable file
24
scripts/gen-proto-docs.sh
Executable file
|
|
@ -0,0 +1,24 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
|
||||
|
||||
PROJECT_BASE=$(git rev-parse --show-toplevel)
|
||||
|
||||
# change to proto directory
|
||||
cd "${PROJECT_BASE}"/protobufs || exit
|
||||
|
||||
git checkout master
|
||||
|
||||
if git submodule status | grep -q '^[-]|^[+]' ; then \
|
||||
echo "INFO: Reinitializing git submodules..."; \
|
||||
git submodule update --init --recursive; \
|
||||
else \
|
||||
echo "INFO: Updating git submodules..."; \
|
||||
git pull --recurse-submodules; \
|
||||
git submodule update --remote --recursive
|
||||
fi
|
||||
|
||||
# remove old generated protos
|
||||
rm -rf "${PROJECT_BASE}/docs/developers/Protobufs/*"
|
||||
|
||||
protoc --doc_opt="${PROJECT_BASE}/protobuf.tmpl,api.mdx" --doc_out="${PROJECT_BASE}/docs/developers/Protobufs/" --proto_path="${PROJECT_BASE}/protobufs" *.proto
|
||||
|
|
@ -71,7 +71,7 @@ const Firmware = (): JSX.Element => {
|
|||
<DownloadCard
|
||||
client="Android"
|
||||
imgUrl="https://f-droid.org/badge/get-it-on.png"
|
||||
url="https://mesh.tastic.app/fdroid/repo"
|
||||
url="https://meshtastic.org/docs/software/android/#f-droid"
|
||||
imgUrl2="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
|
||||
url2="https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source=downloads-page"
|
||||
notes={[
|
||||
|
|
|
|||
Loading…
Reference in a new issue