Commit graph

405 commits

Author SHA1 Message Date
ayysasha 4e81b0f0d5
Updating docs to correct syntax
Syntax correct from xxx_module_xxx to xxx_plugin_xxx
2022-03-18 04:11:36 -04:00
Foster Irwin 4c2c1a7f00 fixed example pointed out by Jim Lahey on discord 2022-03-17 22:42:42 -06:00
Foster Irwin fb46c41ad7
Merge pull request #285 from jfirwin/fix-faq-urls
Fix hardcoded urls to relational urls
2022-03-17 21:10:04 -06:00
andrekir 070efeb0cd remove android location-access.md 2022-03-14 23:28:29 -03:00
Foster Irwin 8d5ec8390e fixed bulletpoints 2022-03-10 15:39:56 -07:00
Foster Irwin f84a502e13 relational link 2022-03-10 15:39:48 -07:00
Foster Irwin 0e21d1849e relational links 2022-03-10 15:37:01 -07:00
Sacha Weatherstone 8468d0cdc8
Fix broken link 2022-03-10 08:19:51 +11:00
Sacha Weatherstone 40cceb2f4b
rename Environmental Measurment 2022-03-10 07:43:13 +11:00
Sacha Weatherstone e8e7605af2 Add docker info 2022-03-10 00:46:31 +11:00
Sacha Weatherstone 5b27a1cf87
Fix build, move to pnpm & ci update 2022-03-09 23:10:04 +11:00
Sacha Weatherstone 57913a2564 Consolidate firmware and build instructions 2022-03-09 20:47:24 +11:00
Sacha Weatherstone f92647ef24 Format with prettier 2022-03-09 18:51:46 +11:00
Sacha Weatherstone 7d6338319b Fix Build 2022-03-09 18:43:38 +11:00
Sacha Weatherstone 7f56825c40 Simplify build instrucions and rename plugins. 2022-03-09 18:10:41 +11:00
Sacha Weatherstone 54ba070db1 Update web overview 2022-03-08 16:24:01 +11:00
Foster Irwin 07941ae336 fixed links 2022-03-03 21:43:52 -07:00
Foster Irwin 01a0436264 web edits 2022-03-03 21:36:12 -07:00
Sacha Weatherstone 89b10cf6ac
Merge pull request #260 from jfirwin/add-wifi-bluetooth-annotation
Web Interface Docs Edits
2022-03-02 10:11:00 +11:00
Ric Letson 0020fd7330
Added renaming of downloaded executables
All other docs simply use "meshtastic" as the command to execute when we give example commands. 

I've added commands to these instructions (for windows, mac & linux) which will rename the meshtastic_ubuntu, meshtastic_mac or meshtastic_windows to simply 'meshtastic' so that user attempts to follow other documentation provided have a better chance at success.
2022-02-28 17:29:38 -07:00
Ric Letson 7239be9b1b
Remove 'double click' reference from windows instructions
Double clicking simply causes the command prompt to flash open and immediately close.
2022-02-28 17:19:14 -07:00
Foster Irwin 9856ba9650
Typo 2022-02-26 00:17:16 -07:00
Mike Kinney bf0f5cf4ca fix instructions 2022-02-25 21:37:23 -08:00
Foster Irwin 12072a06e3 forgot i consolidated the usage page too 2022-02-25 10:57:28 -07:00
Foster Irwin 643b00b6eb renamed web-app.md to overview.md 2022-02-25 10:19:43 -07:00
Foster Irwin 4e2e096fdf consolidated configuration to web-app 2022-02-25 10:19:19 -07:00
Foster Irwin cd2c5adbc9 added meshtastic-flasher to admonitions 2022-02-25 10:18:36 -07:00
Foster Irwin f0c71ebcb0 add admonition to web docs 2022-02-24 21:19:57 -07:00
Foster Irwin 923271aa24 directed instructions to wifi settings page 2022-02-24 20:28:49 -07:00
Foster Irwin c124d095ab consolidated wifi instructions to settings 2022-02-23 06:50:14 -07:00
Foster Irwin a0a19798da moved settings folder 2022-02-21 14:07:19 -07:00
Andre Kirchhoff 3d0f66b16b
fix typo 2022-02-21 08:53:20 -03:00
Andre Kirchhoff 6b2e46fac0
add note about bluetooth to wifi settings 2022-02-21 08:50:43 -03:00
Joshua Pirihi ad606b74e8 Fix the mqtt decryption examples 2022-02-20 19:53:58 +13:00
Joshua Pirihi 7f6d151d23 Fix the mqtt decryption examples 2022-02-20 19:52:57 +13:00
Foster Irwin 2e4436f38e fixed links 2022-02-16 13:53:50 -07:00
Foster Irwin 2a0453a6bf renamed overview pages so that tabs and documentation show description 2022-02-14 11:06:04 -07:00
Foster Irwin aa5d94f0c7
Merge pull request #231 from jfirwin/settings-final-touches
Final touches on Settings pages
2022-02-11 14:19:12 -07:00
Foster Irwin 845c9a2f44 added serial plugin details 2022-02-11 13:54:01 -07:00
Foster Irwin 498ca24757 moved router warning 2022-02-11 13:38:12 -07:00
Foster Irwin e1cb90b22a moved frequency_offset to advanced channel settings 2022-02-11 13:36:22 -07:00
Foster Irwin 6def21c768 added region note 2022-02-11 13:30:43 -07:00
Foster Irwin ee0a41bcc6 added username and password from source code 2022-02-11 13:28:14 -07:00
Foster Irwin 2b72a3c020 updated store and forward 2022-02-11 13:23:54 -07:00
Foster Irwin afc3390546 add notes that user requested 2022-02-11 10:11:40 -07:00
Foster Irwin a4e0d0de99 added txpower details 2022-02-10 19:41:51 -07:00
Foster Irwin bc438211c1 added bandwidth values and coding rate values Placeholder for channelnum 2022-02-10 19:22:44 -07:00
Foster Irwin 230e511451 added descriptions 2022-02-10 17:08:46 -07:00
Foster Irwin a604e516bf added spread factor 2022-02-10 17:03:35 -07:00
RicInNewMexico 0270474274 Update environment.md 2022-02-08 11:58:46 -07:00
Foster Irwin 12b18447b7 removed example from overview 2022-02-08 10:24:57 -07:00
Foster Irwin 08d7593050 added auto_screen_carousel_secs example 2022-02-08 10:14:41 -07:00
Foster Irwin 649a53dd18 removed extra tabs 2022-02-08 10:11:35 -07:00
Foster Irwin 96f634c1ff added ignore_incoming example 2022-02-08 10:11:22 -07:00
Foster Irwin 14c2dfd2b5 corrected titles 2022-02-08 10:11:04 -07:00
Foster Irwin dc4af88013 added hop_limit example 2022-02-08 09:53:49 -07:00
RicInNewMexico 19fac1a4ec Adding MCP9808 sensor to environmental measurement plugin docs 2022-02-07 21:50:40 -07:00
Foster Irwin 879d983cf8 remove unused details section 2022-02-07 11:21:00 -07:00
Foster Irwin c93aab460f remove unused details section 2022-02-07 11:19:56 -07:00
Foster Irwin be2b08c7b5 Add example environmental_measurement_plugin_read_error_count_threshold 2022-02-07 11:19:21 -07:00
Foster Irwin 81bb19e8ce Change self-signed ssl key admonition on WiFi to info 2022-02-07 11:13:37 -07:00
Sacha Weatherstone 25fd81ae74
Merge pull request #229 from jfirwin/downloads-page
Downloads page
2022-02-07 08:33:37 +11:00
Foster Irwin 4be47af7ef Add example for mqtt_username 2022-02-04 16:29:56 -07:00
Foster Irwin 85498267cc Add example for mqtt_password 2022-02-04 16:28:07 -07:00
Foster Irwin f220d78af4 Add example for uplink_enabled 2022-02-04 16:20:10 -07:00
Foster Irwin 23551a6248 add downlink_enabled example 2022-02-04 16:13:41 -07:00
Foster Irwin 27ec972e5d
Merge pull request #230 from jfirwin/settings-work 2022-02-03 17:38:04 -07:00
Foster Irwin c79a8f53b9 fixed encryption 2022-02-03 16:59:11 -07:00
Foster Irwin 51e1630bda missed one 2022-02-03 11:26:19 -07:00
Foster Irwin c103d81e4f reformatted psk docs 2022-02-02 16:34:17 -07:00
Foster Irwin bb2a6ba464 added power examples 2022-02-02 16:29:56 -07:00
Foster Irwin ac42a13d5a moved to admonition 2022-02-02 13:48:24 -07:00
Foster Irwin 09d6038016 add placeholders 2022-02-02 13:46:00 -07:00
Foster Irwin af4aa977b4 updated table 2022-02-02 13:24:12 -07:00
Foster Irwin 98cbaf2ff9 remove todo 2022-02-02 13:01:32 -07:00
Foster Irwin 90b81a4c0a typo 2022-02-02 12:58:04 -07:00
Foster Irwin e74cb880de alphabetize settings 2022-02-02 12:46:12 -07:00
Foster Irwin 829862a33a moved uplink_enabled and downlink_enabled from channels to mqtt 2022-02-02 11:04:57 -07:00
Foster Irwin 3431df8b1e removed spaces from table 2022-02-02 11:02:19 -07:00
Foster Irwin dab825c082 added mqtt encryption setting 2022-02-02 11:02:10 -07:00
Foster Irwin a005e656d1 alphabetized tables 2022-02-02 10:58:56 -07:00
Foster Irwin bf942e26fb moving settings around, adding settings, and fixing things 2022-02-01 18:58:26 -07:00
Ben Meadors 1c81e79c60 Use tag name instead of release name to fix display inconsistency 2022-02-01 11:21:37 -06:00
Ben Meadors 934a82446c File usage 2022-02-01 09:49:00 -06:00
Foster Irwin 950248bac7
Merge pull request #216 from joshpirihi/master
Add how to for decoding mqtt data
2022-01-31 09:57:46 -07:00
Foster Irwin 4c5c818e61
Merge pull request #220 from jfirwin/consolidate-pages-to-settings
Consolidate pages to settings part 1
2022-01-31 08:39:24 -07:00
Foster Irwin 1f4c14646c added ios and web tabs along with placeholder admonitions 2022-01-30 19:29:49 -07:00
joshpirihi 5b1f48e726
Merge branch 'meshtastic:master' into master 2022-01-30 13:23:44 +13:00
Joshua Pirihi 506c7a2a8f Add a how to for decoding mqtt data 2022-01-30 13:23:19 +13:00
andrekir a67e10bdbe fix typo 2022-01-29 10:19:06 -03:00
andrekir c45ec276c6 update play store listing 2022-01-29 10:07:37 -03:00
Joshua Pirihi 08a017f009 Update MQTT page with the current state of affairs 2022-01-29 15:21:05 +13:00
Foster Irwin b701ad1775 some channel settings 2022-01-28 16:07:54 -07:00
Foster Irwin 767b02861c finished sentence 2022-01-28 15:57:08 -07:00
Foster Irwin b687f80eb3 added examples 2022-01-28 15:54:03 -07:00
Foster Irwin 7c2b950dc3 add peripheral admonitions 2022-01-28 15:53:32 -07:00
Foster Irwin 58bdda1332 remove title case 2022-01-28 15:38:20 -07:00
Foster Irwin f337ba771d added configuration not available admonition 2022-01-28 15:36:05 -07:00
Foster Irwin 1eda8a6a1b removed title case from h3s 2022-01-28 15:35:25 -07:00
Foster Irwin 704aecf320 typo 2022-01-28 15:25:48 -07:00
Foster Irwin e50c9052ad added configuration not available admonitions 2022-01-28 15:15:11 -07:00
Foster Irwin 7bc378f78f draw attention to multiple GPIO in the command 2022-01-28 15:09:11 -07:00
Foster Irwin b8dc372b5a added examples 2022-01-28 15:02:30 -07:00
Foster Irwin 3c32a286fb consolidated admonition 2022-01-28 12:16:25 -07:00
Foster Irwin 99a38b0fdd added prerequisites 2022-01-28 11:53:46 -07:00
Foster Irwin dba76fb020 changed plugin admonitions to tip 2022-01-28 11:11:19 -07:00
Foster Irwin fd397bb68e added -plugin to rotary encoder settings page title 2022-01-28 11:07:41 -07:00
Foster Irwin 4bfc7f6ce3 removed "settings" from title and sidebar 2022-01-28 11:06:07 -07:00
Foster Irwin bf5ee28a96 created admonition for canned message requiring additional hardware 2022-01-28 11:05:21 -07:00
Foster Irwin eded6032b0 added linke to rotary encoder plugin 2022-01-28 11:04:46 -07:00
Foster Irwin 71bf78694f standardized plugin id 2022-01-28 11:02:39 -07:00
Foster Irwin 91cee0f808 @prampec's edits from discord 2022-01-28 10:45:37 -07:00
Foster Irwin dfa0f93cd1 changed to empty string for user simplicity, though actually not defined 2022-01-28 10:39:23 -07:00
Foster Irwin d7ec6260dd linked to external notification plugin 2022-01-27 23:36:16 -07:00
Foster Irwin 1c43589fa2 added table to description of allow input source 2022-01-27 23:35:36 -07:00
Foster Irwin c39603426b fixed setting table 2022-01-27 23:34:48 -07:00
Foster Irwin d0740df324 added todo for table of options 2022-01-27 21:43:53 -07:00
Foster Irwin 0a195f2eb7 replaced quotes with tick marks 2022-01-27 21:43:13 -07:00
Foster Irwin b5a5253b0a added description for name 2022-01-27 21:42:32 -07:00
Foster Irwin 74c42378d0 changed admonitions so they wouldn't both be notes 2022-01-27 21:42:19 -07:00
Foster Irwin aaf2d1abcb standardized plugin restart admonition 2022-01-27 21:32:18 -07:00
Mike Kinney 3090bd64fa add info about RAK4631 with env sensor 2022-01-27 17:32:45 -08:00
Foster Irwin 30d317b587 added sensor features 2022-01-27 15:44:42 -07:00
Foster Irwin 8a5953763b added feature table 2022-01-27 15:21:36 -07:00
Foster Irwin 6eb9d77045 moved details over from software/plugins/environment 2022-01-27 14:55:23 -07:00
Foster Irwin 71f3ffb4fc updated overview 2022-01-27 14:54:50 -07:00
Foster Irwin bd81711558 added notes to admonitions 2022-01-27 14:53:53 -07:00
Foster Irwin 9264bb4faa added new sensors 2022-01-27 14:53:09 -07:00
Foster Irwin c1229dbd81 Broke out examples 2022-01-27 14:52:04 -07:00
Foster Irwin a7c7672b26 changed admonition on settings page 2022-01-27 13:55:41 -07:00
Mike Kinney 1e945a8eeb add suffix to images 2022-01-27 12:31:42 -08:00
Mike Kinney 19a0328b32 add environment examples with sensors 2022-01-27 12:27:41 -08:00
mkinney 77ea667156
Merge pull request #208 from mkinney/remote_admin_led
add mor info about remote admin
2022-01-27 09:59:40 -08:00
Mike Kinney 0fa84493f5 add mor info about remote admin 2022-01-27 09:53:25 -08:00
Foster Irwin 24f284194e add link to channel 2022-01-27 10:31:30 -07:00
Foster Irwin 593406b2f1 removed "is_" from uplink_enabled and downlink_enabled 2022-01-27 10:26:02 -07:00
Foster Irwin 2b7edb98fe removed spacing 2022-01-27 10:24:14 -07:00
Foster Irwin cf1010b475 added some parameters to store-and-forward 2022-01-26 16:51:11 -07:00
Foster Irwin 5acb51467d added auto_screen_carousel_secs 2022-01-26 16:36:48 -07:00
Foster Irwin 1289e4cf2c added position_flags 2022-01-26 16:34:58 -07:00
Foster Irwin 2c5f9ce5fe added store_forward_plugin_history_return_window 2022-01-26 16:25:24 -07:00
Foster Irwin a75ee51930 added store_forward_plugin_history_return_max 2022-01-26 16:25:07 -07:00
Foster Irwin ac3c95c605 added store_forward_plugin_heartbeat 2022-01-26 16:24:41 -07:00
Foster Irwin 63538a4eb6 added on_battery_shutdown_after_secs 2022-01-26 16:19:56 -07:00
Foster Irwin 2c2c66d914 added is_always_powered 2022-01-26 16:16:54 -07:00
Foster Irwin 82cabeb30b removed extra column and extra spacing 2022-01-26 16:16:22 -07:00
Foster Irwin a529eb6aae added gps_max_dop 2022-01-26 15:55:00 -07:00
Foster Irwin 0bdd6bf172 Added gps_format 2022-01-26 15:51:40 -07:00
Foster Irwin 985dbbea94 added gps_accept_2d 2022-01-26 15:43:25 -07:00
Foster Irwin a8d243060e added mqtt_username 2022-01-26 15:39:53 -07:00
Foster Irwin eaf2453459 added mqtt_password 2022-01-26 15:39:38 -07:00
Foster Irwin bac23a3689 removed linebreaks 2022-01-26 15:10:09 -07:00
Foster Irwin 6415f97a14 fixed admonition to not take up the whole page 2022-01-26 15:02:03 -07:00
Garth Vander Houwen d07eb0f5c6
Merge pull request #199 from harrylincoln/update-cli-documentation
OSX documentation update
2022-01-24 15:09:47 -08:00
Foster Irwin 1d54cb5a89
Merge pull request #200 from jfirwin/ham-operator
Ham operator settings pages
2022-01-24 13:50:48 -07:00
Foster Irwin a91d9e3700 add changed settings 2022-01-24 13:40:02 -07:00
Foster Irwin 9db123f08c remove todo, this can be handled with tabs if needed later 2022-01-24 11:20:02 -07:00
Foster Irwin c4672822a0 add details section 2022-01-24 10:08:12 -07:00
Foster Irwin 146887b6a0 add ham operator settings page 2022-01-24 09:23:50 -07:00
Harry Lincoln 41de82f7f4 OSX documentation update 2022-01-24 10:25:53 +00:00
Jm Casler aa1c8569af Add python CLI instructions 2022-01-23 20:42:17 -08:00
Jm Casler 9b384ee360 Add some text 2022-01-23 10:19:22 -08:00
Jm Casler a8ccbca8d6 Move the ham page 2022-01-23 10:14:26 -08:00
Mike Kinney 7ff42f4f6f add quotes around cli commands 2022-01-22 13:30:22 -08:00
Mike Kinney 4b4a242dd3 add more info about env sensors 2022-01-22 13:03:40 -08:00
andrekir 251d1965c6 add --ch-index at channel-advanced 2022-01-19 23:10:06 -03:00
Balazs Kelemen c4f49a0d2d CannedMessagePlugin 2022-01-18 23:30:15 +01:00
Mike Kinney 952545a5a0 remove duplicate page; re-format standalone; fix links 2022-01-12 11:14:44 -08:00
mkinney efabfc2c3f
Merge pull request #178 from gjedeer/master
Clarify PSK related documentation
2022-01-11 12:54:22 -08:00
Mike Kinney 8ddd7709b0 add standalone python info 2022-01-11 12:51:33 -08:00
GDR! 0ccc85c685 put the note about using random PSK into an admonition 2022-01-11 20:26:15 +01:00
GDR! 8c982b0917
Better wording for PSK 2022-01-11 17:45:19 +01:00
GDR! 275e9d5af6
Clarify PSK docs
Add all possible values of the setting `psk` and clarify which
settings are secure and which are not. Closes issue #176
2022-01-11 17:42:43 +01:00
andrekir b2c94eeec7 update android usage.md 2022-01-11 11:33:36 -03:00
Sacha Weatherstone 98d0cd2059 Fixes & cleanup 2022-01-09 12:03:14 +11:00
Ben Meadors 18b12f7dd7 Configure help 2022-01-07 20:27:15 -06:00
linagee 273732d96e
Merge branch 'master' of github.com:meshtastic/Meshtastic 2022-01-05 13:14:25 -07:00
Dale Floer 8913391201 Update broken link. 2022-01-03 20:15:33 -08:00
Dale Floer 7dbec175de Updated link to new instructions. 2022-01-03 20:11:41 -08:00
Dale Floer 458300c07a Update python docs path. 2022-01-03 19:56:25 -08:00
linagee 4baa91d266
Many documentation typos fixed 2022-01-02 23:53:45 -07:00
Sacha Weatherstone fc7c20565c More broken links 2022-01-02 18:12:28 +11:00
Sacha Weatherstone 8ab2403549 Fix build & use absolute paths across the board 2022-01-02 18:03:24 +11:00
Sacha Weatherstone 187e3cc9aa Restructure hardware pages 2022-01-02 17:54:49 +11:00
linagee e93c5c0581
Merge master (#4)
* Fix typo

* Update on the delayed meshpacket type.

* fixed typo in store forward doc

* Updated notes for the delayed enum

* Add note about stability to S&F doc

* Firmware loading placeholder

* add notes on mqtt stuff

* change link to python api docs

* re-org of python docs; migrate docs out of python repo README into this repo

* fix links

* Update protobuf submodule

* Update protobuf submodule

* Update protobuf submodule

* Update protobuf submodule

* Update protobuf submodule

* Fix typo

* Update protobuf submodule

* Fix typos in radio setting table

Co-authored-by: Jm Casler <jm@casler.org>
Co-authored-by: Sacha Weatherstone <sachaw100@hotmail.com>
Co-authored-by: Mike Kinney <mike.kinney@gmail.com>
Co-authored-by: github-actions <bot@noreply.github.com>
Co-authored-by: redfast00 <redfast00@gmail.com>
Co-authored-by: Ben Meadors <benmmeadors@gmail.com>
2022-01-01 20:14:21 -07:00
Mike Kinney ac28557d47 fix links 2021-12-29 11:11:03 -08:00
Mike Kinney c2e6c96616 re-org of python docs; migrate docs out of python repo README into this repo 2021-12-29 10:49:34 -08:00
Mike Kinney 5364c00da5 add notes on mqtt stuff 2021-12-28 13:27:27 -08:00
Sacha Weatherstone f6cbf6c899
Merge pull request #160 from linagee/master
Typos, spelling, and grammar corrected in documentation
2021-12-28 20:52:28 +10:30
linagee 1ffa55d39a
"HAM" is like nails on a chalkboard to Ham operators
Also I fixed the output from the firmware, this will need to
change in code to make it reflect this.
2021-12-27 20:54:32 -07:00
linagee 474f54a32a
Small grammar correction just noticed 2021-12-27 14:28:55 -07:00
linagee f2e22d63c9
Typos, spelling, and grammar corrected (#3)
Thanks to aspell and languagetool. Hand picked from these, there are too
many strange things in the English language to be perfectly syntactical.
2021-12-27 12:39:42 -07:00
Jm Casler 5ea754b52c Add note about stability to S&F doc 2021-12-27 10:51:13 -08:00
Jm Casler ac236a1ce3 Updated notes for the delayed enum 2021-12-27 10:48:33 -08:00
Jm Casler f430a742ac fixed typo in store forward doc 2021-12-27 10:41:27 -08:00
Jm Casler 6b57508ef2 Update on the delayed meshpacket type. 2021-12-27 10:31:34 -08:00
Garth Vander Houwen 34358034e6 Merge branch 'master' of https://github.com/garthvh/Meshtastic 2021-12-24 09:28:53 -08:00
Mike Kinney 4597b76c0e add more to the example from chrisbee input 2021-12-22 16:06:09 -08:00
Mike Kinney d77b684a7f fix example in branch this time 2021-12-22 15:58:04 -08:00
Mike Kinney d972784b9d Revert "fix example"
This reverts commit 9bde16bde7.
2021-12-22 15:56:28 -08:00
Mike Kinney 9bde16bde7 fix example 2021-12-22 15:54:17 -08:00
Sacha Weatherstone 17befd9a7d Merge branch 'master' of github.com:meshtastic/meshtastic 2021-12-23 01:43:03 +11:00
Sacha Weatherstone 988f7c489f New showcase structure + fixes 2021-12-23 01:42:57 +11:00
Mike Kinney e4f519fb50 add imports; change interface calls 2021-12-21 11:25:57 -08:00
Sacha Weatherstone f186c6803a Move website to repo root 2021-12-21 22:44:01 +11:00