Skip to content

Commit 94b5d8c

Browse files
committed
more docs work/getting basics in place
1 parent 542756a commit 94b5d8c

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

docs/api_device.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,4 +153,17 @@ uint8_t getMessageLevel(void)
153153

154154
| Parameter | Type | Description |
155155
| :------------ | :---------- | :---------------------------------------------- |
156-
| return value | `uint8_t` | The current message level settings|
156+
| return value | `uint8_t` | The current message level settings|
157+
158+
### setOutputDevice()
159+
This method is called to provide an output Serial device that the is used to output messages from the underlying AMS SDK.
160+
161+
This is needed when debug or info messages are enabled in the library
162+
163+
```C++
164+
void setOutputDevice(Stream& theStream)
165+
```
166+
167+
| Parameter | Type | Description |
168+
| :------------ | :---------- | :---------------------------------------------- |
169+
| `theStream` | `Stream` | The output stream device - normally a Serial port. |

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,5 +80,5 @@ nav:
8080
- Device: api_device.md
8181
- Setup: api_setup.md
8282
- Operation: api_tmf882x.md
83-
- Examples: '!include ./examples/mkdocs.yml'
83+
8484

0 commit comments

Comments
 (0)