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

Merge branch 'master' of github.com:meshtastic/meshtastic

Browse source
This commit is contained in:
Sacha Weatherstone 2021-11-30 21:46:36 +11:00
parent f1a50b3a99 b84389ade1
commit e538ac24d1
2 changed files with 39 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
website/docs/developers/publish.md
View file

@ -10,17 +10,19 @@ If you’d like to do ‘real’ releases with your changes, the procedure is:
## Device ## Device
* Update protobufs
* * cd proto
* * git checkout master && git pull
* * cd ..
* * git add proto
* * git commit -m "updating proto submodule to latest"
* run bin/regen-protos.sh
* edit version.properties and check it into the root project * edit version.properties and check it into the root project
* run bin/promote-release.sh - this should cause github to start a release build (see the CI actions) * run bin/promote-release.sh - this should cause github to start a release build (see the CI actions)
* edit the draft release text and click publish * edit the draft release text and click publish
### Update Protobufs ### Update Protobufs
* cd proto
* git checkout master && git pull
* cd ..
* git add proto
* git commit -m "updating proto submodule to latest"
## Android ## Android
@ -32,10 +34,32 @@ TBD
## Python ## Python
if any dev wants to take this on, send me a note and I’ll bless you with pypi ### Pre-requistes
* Python Packages
* * pip3 install pdoc3
* * pip3 install pygatt
* * pip3 install pandoc
* * pip install twine
* https://pandoc.org/installing.html
* nanopb 0.4.4 installed
### Instructions
* Update protobufs
* * cd proto
* * git checkout master && git pull
* * cd ..
* * git add proto
* * git commit -m "updating proto submodule to latest"
* run bin/regen-protos.sh
* bump the version in setup.py * bump the version in setup.py
* run bin/test-release.sh
* * Ensure no errors.
* run bin/upload-release.sh * run bin/upload-release.sh
I usually just edit setup.py to bump the version number, then run "bin/upload-release.sh" (though you should use bin/test-release.sh for the first time - which is just a dry deploy to the pypi test server). This script does the build (including new docs - which will end up in the git checkin) and upload to pypi. Then I do a git commit/push and tag wit the version number.
:::note :::note
You need permissions in the github project to make a build::: You need permissions in the github project to make a build
:::

14
website/docs/software/settings/power.md
View file

@ -14,10 +14,10 @@ Power settings on a Meshtastic device can be set like other user-define settings
For example, if we wanted to disable sleep mode, like when we put the device into router mode, we could use the command: For example, if we wanted to disable sleep mode, like when we put the device into router mode, we could use the command:
```bash ```bash
meshtastic --set mesh_sds_timeout_secs MAXUNIT meshtastic --set mesh_sds_timeout_secs 4294967295
``` ```
:::note :::note
See MAXUNIT from `mesh_sds_timeout_secs` below: See MAXUINT from `mesh_sds_timeout_secs` below:
For a description and more information on what exactly all of these mean, please refer to [Power Management State Machine](../other/power) For a description and more information on what exactly all of these mean, please refer to [Power Management State Machine](../other/power)
@ -31,7 +31,7 @@ For a description and more information on what exactly all of these mean, please
| ls_secs | `integer` (seconds) | `0` (see note) | | ls_secs | `integer` (seconds) | `0` (see note) |
| mesh_sds_timeout_secs | `integer` (seconds) | `0` | | mesh_sds_timeout_secs | `integer` (seconds) | `0` |
| min_wake_secs | `integer` (seconds) | `0` | | min_wake_secs | `integer` (seconds) | `0` |
| phone_sds_timeout_sec | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../other/power) for details. 0 for default of two hours, MAXUINT for disabled | | phone_sds_timeout_sec | `integer` (seconds) | `0` | Power management state machine option. See the [power page](../other/power) for details. 0 for default of two hours, use the value of MAXUINT or 4294967295 to disable |
| phone_timeout_secs | `integer` (seconds) | `0` | | phone_timeout_secs | `integer` (seconds) | `0` |
| screen_on_secs | `integer` (seconds) | `0` | | screen_on_secs | `integer` (seconds) | `0` |
| sds_secs | `integer` (seconds) | `0` | | sds_secs | `integer` (seconds) | `0` |
@ -69,7 +69,7 @@ Power management state machine option. See the [power page](../other/power) for
### mesh_sds_timeout_secs ### mesh_sds_timeout_secs
Power management state machine option. See the [power page](../other/power) for details. 0 for default of two hours, MAXUINT for disabled Power management state machine option. See the [power page](../other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable
### min_wake_secs ### min_wake_secs
@ -77,7 +77,7 @@ Power management state machine option. See the [power page](../other/power)for d
### phone_sds_timeout_sec ### phone_sds_timeout_sec
Power management state machine option. See the [power page](../other/power) for details. 0 for default of two hours, MAXUINT for disabled Power management state machine option. See the [power page](../other/power) for details. 0 for default of two hours, use the MAXUINT or 4294967295 to disable
### phone_timeout_secs ### phone_timeout_secs
@ -112,7 +112,9 @@ Power management state machine option. See the [power page](../other/power) for
]}> ]}>
<TabItem value="cli"> <TabItem value="cli">
TODO ```bash
meshtastic --set mesh_sds_timeout_secs 0
```
</TabItem> </TabItem>
<TabItem value="android"> <TabItem value="android">