Skip to content

Commit af4f594

Browse files
committed
Update README.md
1 parent 8589b63 commit af4f594

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -153,24 +153,27 @@ Add the Keys you want to get using ```addCfgValget``` :
153153
myGNSS.addCfgValget(&customCfg, UBLOX_CFG_UART1_BAUDRATE); // Get the UART1 baud rate
154154
```
155155

156-
Perform the VALGET by calling ```sendCfgValget(&customCfg)```. The method returns true if the VALGET was successful.
156+
Perform the VALGET by calling ```sendCfgValget(&customCfg);```. The method returns true if the VALGET was successful.
157157

158158
Extract the Key Values using the template method ```extractConfigValueByKey```.
159159

160160
**Note:** you do still need to know the data type to extract the data correctly.
161161

162162
Consult the u-blox Interface Description or [u-blox_config_keys.h](./src/u-blox_config_keys.h) to see the data type (size) for each Key ID.
163-
* L : bool
164-
* U1/E1/X1 : uint8_t
165-
* I1 : int8_t
166-
* U2/E2/X2 : uint16_t
167-
* I2 : int16_t
168-
* U4/E4/X4 : uint32_t
169-
* I4 : int32_t
170-
* U8/X8 : uint64_t
171-
* I8 : int64_t
172-
* R4 : float (32-bit)
173-
* R8 : double (64-bit)
163+
164+
| Size | Type |
165+
|---|---|
166+
| L | bool |
167+
| U1/E1/X1 | uint8_t |
168+
| I1 | int8_t |
169+
| U2/E2/X2 | uint16_t |
170+
| I2 | int16_t |
171+
| U4/E4/X4 | uint32_t |
172+
| I4 | int32_t |
173+
| U8/X8 | uint64_t |
174+
| I8 | int64_t |
175+
| R4 | float (32-bit) |
176+
| R8 | double (64-bit) |
174177

175178
Pass a pointer to, or the address of, your variable plus its size (in bytes) to ```extractConfigValueByKey``` to extract the value.
176179
The method returns true if the extraction was successful.
@@ -180,7 +183,7 @@ The method returns true if the extraction was successful.
180183
myGNSS.extractConfigValueByKey(&customCfg, UBLOX_CFG_UART1_BAUDRATE, &baud, sizeof(baud)); // Get the baud rate - using the key and the address of and sizeof baud
181184
```
182185

183-
Please see [VALGET_and_VALSET/Example6](./examples/VALGET_and_VALSET/Example6_multiSetVal_and_GetVal_Templates/) for more details.
186+
Please see [VALGET_and_VALSET/Example6](./examples/VALGET_and_VALSET/Example6_multiSetVal_and_GetVal_Templates/Example6_multiSetVal_and_GetVal_Templates.ino) for more details.
184187

185188
#### Multiple-VALSET
186189

@@ -204,7 +207,7 @@ Add each key and value that you wish to set. The type / size is deduced automati
204207

205208
Finally, send the VALSET by calling ```sendCfgValset();```. The method returns true if the VALSET was successful.
206209

207-
Please see [VALGET_and_VALSET/Example6](./examples/VALGET_and_VALSET/Example6_multiSetVal_and_GetVal_Templates/) for more details.
210+
Please see [VALGET_and_VALSET/Example6](./examples/VALGET_and_VALSET/Example6_multiSetVal_and_GetVal_Templates/Example6_multiSetVal_and_GetVal_Templates.ino) for more details.
208211

209212
If you are setting many configuration items, such that the number of keys and values could overflow ```packetCfg```, you can use the
210213
method ```autoSendCfgValsetAtSpaceRemaining``` to send a VALSET automatically when packetCfg is almost full. E.g.:
@@ -213,7 +216,7 @@ method ```autoSendCfgValsetAtSpaceRemaining``` to send a VALSET automatically wh
213216
myGNSS.autoSendCfgValsetAtSpaceRemaining(16); // Trigger an auto-send when packetCfg has less than 16 bytes are remaining
214217
```
215218

216-
Please see [VALGET_and_VALSET/Example4](./examples/VALGET_and_VALSET/Example4_multiSetVal/) for more details.
219+
Please see [VALGET_and_VALSET/Example4](./examples/VALGET_and_VALSET/Example4_multiSetVal/Example4_multiSetVal.ino) for more details.
217220

218221
## Compatibility
219222

0 commit comments

Comments
 (0)