From d7fe15da1f396770844e78ca87b50f47e4e91044 Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Tue, 12 Sep 2023 16:01:30 -0700 Subject: [PATCH] Update Usage Example in Readme --- README.rst | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 3e21f93d..30c64ed2 100755 --- a/README.rst +++ b/README.rst @@ -77,15 +77,27 @@ To install in a virtual environment in your current project: Usage Example ============= -At the time of writing (`git:7fc1f8ab `_), -the following sequence runs through some basic testing of the digitalio compatibility layer... +The pin names may vary by board, so you may need to change the pin names in the code. This +example runs on the Raspberry Pi boards to blink an LED connected to GPIO 18 (Pin 12): .. code-block:: python - from testing import test_module_name - test_module_name("testing.universal.digitalio") + import time + import board + import digitalio -An example log from running the suites is `here `_ . + PIN = board.D18 + + print("hello blinky!") + + led = digitalio.DigitalInOut(PIN) + led.direction = digitalio.Direction.OUTPUT + + while True: + led.value = True + time.sleep(0.5) + led.value = False + time.sleep(0.5) Contributing ============