Skip to content

Commit 2184938

Browse files
authored
Update README.md
1 parent 07a287c commit 2184938

File tree

1 file changed

+10
-20
lines changed

1 file changed

+10
-20
lines changed

README.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ A PlatformmIO parser library for Hamlib rotator control commands.
66
- from C-struct to string (response)
77
- Programmed with less dependencies in C for C and C++ projects.
88
- Requires float support for `scanf` and `printf`.
9+
- [Commands reference](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/tree/main/src/)
910

1011
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/rubienr/library/HamlibRotctlEasycommParser.svg)](https://registry.platformio.org/libraries/rubienr/HamlibRotctlEasycommParser)
1112

12-
[**Integrate in project:**](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/platformio.ini)
13+
**Integrate in project [example](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/platformio.ini)**
1314
```ini
1415
# platformio.ini
1516
[env:xxx]
@@ -20,13 +21,13 @@ lib_deps = rubienr/HamlibRotctlEasycommParser
2021
# some platforms require folat support for scanf/printf to be explicitely enabled
2122
build_flags =
2223
# if platfrom is atmelavr:
23-
# -Wl,-u,vfscanf,-lscanf_flt,-u,vfprintf,-lprintf_flt
24-
# if platform is ststm32:
25-
# -Wl,-u_scanf_float,-u_printf_float
24+
-Wl,-u,vfscanf,-lscanf_flt,-u,vfprintf,-lprintf_flt
25+
# if platform is [...]
2626
```
2727

28-
[**Parse a single command:**](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/src/example-parse-command.cpp)
28+
**Parse a single command [example](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/src/example-parse-command.cpp)**
2929
```c
30+
// main.c
3031
void setup() {}
3132

3233
void loop()
@@ -53,8 +54,9 @@ void loop()
5354
}
5455
```
5556

56-
[**Parse with callback:**](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/src/example-parse-with-callback.cpp)
57+
**Parse with callback [example](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/src/example-parse-with-callback.cpp)**
5758
```c
59+
// main.c
5860
void customCallback(const EasycommData *command, void *custom_data)
5961
{
6062
*((bool *)custom_data) = true;
@@ -97,20 +99,8 @@ void loop()
9799
**Parse from stream:** [see full example](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/src/example-parse-stream.cpp)
98100
99101
**More examples:**
100-
101-
* [native-integration-test-program.cpp](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/src/native-integration-test-program.cpp)
102-
* [unit tests](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/test/)
103-
104-
**References:**
105-
106-
* [Command reference](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/tree/main/src/)
107-
* Easycomm protocol
108-
* rotctl --list
109-
* rotctl --model=204 --dump-caps
110-
* Hamlib
111-
* [protocol description](https://github.com/Hamlib/Hamlib/tree/master/rotators/easycomm/easycomm.txt)
112-
* [protocol source](https://github.com/Hamlib/Hamlib/tree/master/rotators/easycomm/easycomm.c)
113-
102+
[native-integration-test-program.cpp](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/src/native-integration-test-program.cpp),
103+
[unit tests](https://github.com/yapiolibs/hamlib-rotctl-easycomm-parser/blob/main/test/test/)
114104
115105
**Checks**
116106

0 commit comments

Comments
 (0)