Skip to content

Commit

Permalink
adapted readme to release 20220302
Browse files Browse the repository at this point in the history
  • Loading branch information
andreas committed Mar 2, 2022
1 parent a288959 commit b1bd523
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
7 changes: 7 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,13 @@ For details refer to the [example description](lib/exampletask/Readme.md).

Changelog
---------
[20220302](../../releases/tag/20220302)
*********
* add export and import of config data.<br>
HINT: **passwords are not included**
* add a HELP tab that points to this description<br>
The url can be changed using the HELP_URL capability

[20220301](../../releases/tag/20220301)
*********
* change [boat data names to shorter ones](../../issues/17)
Expand Down
2 changes: 1 addition & 1 deletion lib/exampletask/GwExampleTask.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ DECLARE_CAPABILITY(testboard2,true);
//hide some config value
//just set HIDE + the name of the config item to true
DECLARE_CAPABILITY(HIDEminXdrInterval,true);

//example for a user defined help url that will be shown when clicking the help button
DECLARE_STRING_CAPABILITY(HELP_URL,"https://www.wellenvogel.de");
#endif
7 changes: 5 additions & 2 deletions lib/exampletask/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@ Files
This file is completely optional.
You only need this if you want to
extend the base configuration - we add a dummy library here and define one additional build environment (board)
* [GwExampleTask.h](GwExampleTask.h) the name of this include must match the name of the directory (ignoring case) with a "gw" in front. This file includes our special hardware definitions and registers our task at the core (DECLARE_USERTASK in the code). Optionally it can define some capabilities (using DECLARE_CAPABILITY) that can be used in the config UI (see below).
Avoid including headers from other libraries in this file as this could interfere with the main code. Just only include them in your .cpp files (or in other headers).
* [GwExampleTask.h](GwExampleTask.h) the name of this include must match the name of the directory (ignoring case) with a "gw" in front. This file includes our special hardware definitions and registers our task at the core (DECLARE_USERTASK in the code). Avoid including headers from other libraries in this file as this could interfere with the main code. Just only include them in your .cpp files (or in other headers).
Optionally it can define some capabilities (using DECLARE_CAPABILITY) that can be used in the config UI (see below)
There are some special capabilities you can set:
* HIDEsomeName: will hide the configItem "someName"
* HELP_URL: will set the url that is loaded when clicking the HELP tab (user DECLARE_STRING_CAPABILITY)
* [GwExampleTaks.cpp](GwExampleTask.cpp) includes the implementation of our task. This tasks runs in an own thread - see the comments in the code.
We can have as many cpp (and header files) as we need to structure our code.
* [config.json](config.json)<br>
Expand Down

0 comments on commit b1bd523

Please sign in to comment.