X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/blobdiff_plain/e8e22c512ce0ea491c9c273c7ab1a92d78d0c39b..07b96113f5c7f511bcdbc32e16d0777ae4f22529:/README.rst diff --git a/README.rst b/README.rst index 5e9c020..d2957fd 100755 --- a/README.rst +++ b/README.rst @@ -9,8 +9,8 @@ Introduction :target: https://adafru.it/discord :alt: Discord -.. image:: https://travis-ci.com/adafruit/Adafruit_Blinka.svg?branch=master - :target: https://travis-ci.com/adafruit/Adafruit_Blinka +.. image:: https://github.com/adafruit/Adafruit_Blinka.svg/workflows/Build%20CI/badge.svg + :target: https://github.com/adafruit/Adafruit_Blinka/actions :alt: Build Status .. image:: https://img.shields.io/badge/code%20style-black-000000.svg @@ -20,12 +20,10 @@ Introduction This repository contains a selection of packages emulating the CircuitPython API for devices or hosts running CPython or MicroPython. Working code exists to emulate these CircuitPython packages: -* **_typing** - (Legacy) subset of types for C-level protocols * **analogio** - analog input/output pins, using pin identities from board+microcontroller packages * **bitbangio** - software-driven interfaces for I2C, SPI * **board** - breakout-specific pin identities * **busio** - hardware-driven interfaces for I2C, SPI, UART -* **circuitpython_typing** - Subset of types for C-level protocols * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages * **keypad** - support for scanning keys and key matrices * **microcontroller** - chip-specific pin identities @@ -34,6 +32,7 @@ for devices or hosts running CPython or MicroPython. Working code exists to emul * **pulseio** - contains classes that provide access to basic pulse IO (PWM) * **pwmio** - contains classes that provide access to basic pulse IO (PWM) * **rainbowio** - provides the colorwheel() function +* **usb_hid** - act as a hid-device using usb_gadget kernel driver For details, see the `Blinka API reference `_. @@ -78,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 ============