Skip to content

Commit

Permalink
Updated API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MrYsLab committed Oct 30, 2023
1 parent cae3d4c commit 0cb9db0
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
18 changes: 18 additions & 0 deletions docs/pin_modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,24 @@ In this section, the methods to set pin modes are presented. For each API method
provided. The API parameters for both telemetrix and telemetrix-aio are identical for setting pin modes, except
telemetrix-aio method definitions are prefixed with the Python _async_ keyword.

**NOTE:** If you setting the mode for multiple pins, you may wish to add a short delay
after setting each pin.

```angular2html
import time
from telemetrix import telemetrix
class Main:
def __init__(self):
self.board = telemetrix.Telemetrix()
# init password buttons callback
for i in range(10, 23):
self.board.set_pin_mode_digital_input_pullup(i, callback=self.ringBack)
# add a short delay
time.sleep(.02)
```

## Setting Pin Modes

### set_pin_mode_analog_input
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ site_name: Telemetrix and Telemetrix-AIO User's Guide
repo_url: https://github.com/MrYsLab/telemetrix
copyright: > # should remain a link to the original theme
Copyright © 2020-2023 Alan Yorinks           Last
Modified: October 23, 2023
Modified: October 30, 2023
nav:
- Introduction: index.md
Expand Down

0 comments on commit 0cb9db0

Please sign in to comment.