tasmota/docs

Please provide List of JSON [{'command':'Description'}] for Flutter app compatibility.

Open

#1,071 opened on Oct 3, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (751 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (Avg merge 14h 3m) (2 merged PRs in 30d)

Description

@ re PR: arendst/tasmota#

Please add the new feature to the appropriate article in Tasmota documentation

Hello arendst,

I am developing app called SWiBaord that helps configure and control tasmota devices using MQTT5 protocol. I want to have a json of commands and corresponding command description i.e.

[{'command1':'this awesome command does something'},
{'command2':'this awesome command does something too'}]

Currently I have added list of coomands by hand parsing json from the commands.md file. like as given below picture. But as the dynamic nature of the list of commands and it's description it keeps changing and it is hard to keep track of the changes and add to app. Screenshot from 2022-10-03 09-05-22

And my app screenshot is : photo_2022-10-03_09-06-28

Hope to get reply from you soon.

hjlabs.in

Contributor guide

Research direction
Explore the Tasmota source code repository to understand how commands are defined, then write a script to extract all command names and descriptions and output a JSON file.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70