python icon indicating copy to clipboard operation
python copied to clipboard

Proposition: add description and details of set variables in CLI

Open charlesmarseille opened this issue 3 years ago • 2 comments

Instead of refering to the online docs each time we work in the CLI, typing meshtastic --get 0 could output the following structure:

display: display.auto_screen_carousel_secs # time between screen pages rotation (seconds) display.compass_north_top # impose compass orientation (bool) display.flip_screen # orientation of oled screen (bool) display.gps_format # format of lat, lon coordinates ("gpsFormatDec", "gpsFormatDms", ...)
display.screen_on_secs # Time to keep screen on (seconds) display.units # .....

Having the description, setting value type and possible values and exceptions would be useful.

charlesmarseille avatar Oct 31 '22 13:10 charlesmarseille

Great idea, feel free to send in a pull request

garthvh avatar Oct 31 '22 14:10 garthvh

I'll give a first draft, but some settings I have no idea what values they take and are not described in the docs. I'll have to search the code. I'll give it a go and ask for completion from you guys.


De : Garth Vander Houwen @.> Envoyé : 31 octobre 2022 10:01 À : meshtastic/python @.> Cc : charlesmarseille @.>; Author @.> Objet : Re: [meshtastic/python] Proposition: add description and details of set variables in CLI (Issue #393)

Great idea, feel free to send in a pull request

— Reply to this email directly, view it on GitHubhttps://github.com/meshtastic/python/issues/393#issuecomment-1297138028, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AIUJ3YK47ENYNEIQV4T5DT3WF7GKLANCNFSM6AAAAAARTCSGF4. You are receiving this because you authored the thread.Message ID: @.***>

charlesmarseille avatar Oct 31 '22 14:10 charlesmarseille