Difference between revisions of "Circuitpython"

From Sketching with Hardware at LMU Wiki
Jump to navigation Jump to search
(36 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
[https://learn.adafruit.com/welcome-to-circuitpython Introduction and step by step tutorial from Adafruit]
 +
 +
= Installing CircuitPython =
 +
 +
Go to [https://circuitpython.org/downloads circuitpython.org/downloads] and download the version for your board.
 +
 +
For the Raspberry PI Pico connect the board to the computer and the folder RPI-RP2 shows ups in your file system. For the Arduino Nano Connect RP2040 [https://www.sketching-with-hardware.org/wiki/Arduino_Nano_RP2040_Connect#Install_the_Arduino_Nano_RP2040_Connect_Firmware force the bootloder mode] to upload the .uf2 file. Copy the .uf2 into the folder of the board.
 +
 +
[[File:Cp01.png|x250px]] [[File:Cp02.png|x250px]]
 +
 +
Now you should be able to connect to the board and use the editor.
 +
 +
If you need more help, here is a [https://learn.adafruit.com/welcome-to-circuitpython/installing-circuitpython more detailed description on the installation process at adafruit.com]
 +
 +
On the download site there is also a webbased download process - where the browser makes a serial connection to the board.
 +
 +
= CircuitPy Drive =
 +
 +
After installing CircuitPython on the board and reconnecting the board, it should show up as a USB drive on your computer with the name CircuitPy.
 +
 +
Here you can directly access the code you write and data you safe from your programs.
 +
 +
[[File:Cp05-usb-drive.png|x300px]]
 +
 +
As the board is a USB drive do not just unplug it - use "safe remove" feature of your OS.
 +
 +
[[File:Cp06-safe-remove.png|200px]]
 +
[[File:Cp07-safe-remove.png|200px]]
 +
 +
= Running your first CircuitPython Program  =
 +
 +
In the file system of the board (that shows up as USB Drive CIRCUITPY) there is a file code.py.
 +
 +
To write your program, open code.py and edit it with your code. Once you safe it, it will be automatically excuted. The file name must be code.py or main.py.
 +
 +
Try it out with the following program. Just use any editor and open code.py. Replace it with the following code and you should see the LED flash. Changes the sleep times. Each time you safe it the new program will be active:
 +
 +
<syntaxhighlight lang="python" line='line'>
 +
# write on serial line and blink onbaord LED
 +
import board
 +
import digitalio
 +
import time
 +
 +
led = digitalio.DigitalInOut(board.LED)
 +
led.direction = digitalio.Direction.OUTPUT
 +
 +
while True:
 +
    led.value = False
 +
    time.sleep(0.8)
 +
    led.value = True
 +
    time.sleep(0.2)
 +
</syntaxhighlight>
 +
 +
 +
<syntaxhighlight lang="python" line='line'>
 +
# check input, switch LED, write on serial line
 +
import board
 +
import digitalio
 +
from digitalio import DigitalInOut, Direction, Pull
 +
import time
 +
 +
led = digitalio.DigitalInOut(board.LED)
 +
led.direction = digitalio.Direction.OUTPUT
 +
 +
switch = DigitalInOut(board.D2)
 +
switch.direction = Direction.INPUT
 +
switch.pull = Pull.UP
 +
 +
while True:
 +
    time.sleep(0.2)
 +
    if switch.value:
 +
        led.value = False
 +
        print("Off")
 +
    else:
 +
        led.value = True
 +
        print("On")
 +
</syntaxhighlight>
 +
 +
= Using Libraries =
 +
Here are examples of how to use libraries.
 +
 +
== accelerometer of the Arduino Nano Connect RP2024 ==
 +
How to read the accelerometer of the Arduino Nano Connect RP2024.
 +
 +
Download the library (in this case it is in the zip from Adafruit, see [https://learn.adafruit.com/circuitpython-on-the-arduino-nano-rp2040-connect/accelerometer-gyroscope Download Project Bundle]).
 +
 +
Copy the library folders into the library folder on the USB drive (CIRCUITPY).
 +
 +
[[File:Cp08-lib.png|x250px]]
 +
[[File:Cp09-lib02.png|x250px]]
 +
 +
Now you can use the libraries, e.g. for reading the accelerometer using the adafruit_lsm6ds library.
 +
 +
 +
<syntaxhighlight lang="python" line='line'>
 +
# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries
 +
#
 +
# SPDX-License-Identifier: MIT
 +
import time
 +
import board
 +
from adafruit_lsm6ds.lsm6dsox import LSM6DSOX
 +
 +
i2c = board.I2C()  # uses board.SCL and board.SDA
 +
# i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
 +
sensor = LSM6DSOX(i2c)
 +
 +
while True:
 +
    print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (sensor.acceleration))
 +
    print("Gyro X:%.2f, Y: %.2f, Z: %.2f radians/s" % (sensor.gyro))
 +
    print("")
 +
    time.sleep(0.5)
 +
</syntaxhighlight>
 +
 +
for more details see: [https://learn.adafruit.com/circuitpython-on-the-arduino-nano-rp2040-connect/accelerometer-gyroscope on how to use the onboard IMU of the Arduino Nano RP2040 Connect (LSM6DSOXTR)]
 +
 +
== Keyboard emulator ==
 +
 +
[https://learn.adafruit.com/circuitpython-essentials/circuitpython-hid-keyboard-and-mouse for more details on the mouse and keyboard emulator see the Adafruit page]
 +
 +
We have also an [[KeyboardEmulator | example, where the IMU of the Arduino Nano Connect RP2040 is read and strings are send to the computer]].
 +
 +
<syntaxhighlight lang="python" line='line'>
 +
# SPDX-FileCopyrightText: 2018 Kattni Rembor for Adafruit Industries
 +
#
 +
# SPDX-License-Identifier: MIT
 +
 +
"""CircuitPython Essentials HID Keyboard example"""
 +
import time
 +
import board
 +
import digitalio
 +
from digitalio import DigitalInOut, Direction, Pull
 +
import usb_hid
 +
from adafruit_hid.keyboard import Keyboard
 +
from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
 +
from adafruit_hid.keycode import Keycode
 +
 +
led = digitalio.DigitalInOut(board.LED)
 +
led.direction = digitalio.Direction.OUTPUT
 +
 +
switch = DigitalInOut(board.D2)
 +
switch.direction = Direction.INPUT
 +
switch.pull = Pull.UP
 +
 +
# The keyboard object!
 +
time.sleep(1)  # Sleep for a bit to avoid a race condition on some systems
 +
keyboard = Keyboard(usb_hid.devices)
 +
keyboard_layout = KeyboardLayoutUS(keyboard)  # We're in the US :)
 +
 +
 +
while True:
 +
    time.sleep(2)
 +
    if switch.value:
 +
        led.value = False
 +
        print("Off")
 +
    else:
 +
        led.value = True
 +
        print("On")
 +
        keyboard_layout.write("Hi There")  # ...Print the string
 +
</syntaxhighlight>
 +
 +
= Finding your PIN names - Pin mapping script =
 +
 +
CircuitPython uses it own names which makes it easier to use the same code on different boards. But this requires you to first find out which PINs on your physical board map to the logical pins in the program code.
 +
 +
There is a [https://learn.adafruit.com/circuitpython-essentials/circuitpython-pins-and-modules pin mapping scriptt avaiable for this at Adafruit]. You can download the [https://learn.adafruit.com/circuitpython-essentials/circuitpython-pins-and-modules project bundel there]. Here is the script, too. And below are the mappings for the Arduino Nano Connect RP2024 and the Raspberry Pi Pico
 +
 +
<syntaxhighlight lang="python" line='line'>
 +
# SPDX-FileCopyrightText: 2020 anecdata for Adafruit Industries
 +
# SPDX-FileCopyrightText: 2021 Neradoc for Adafruit Industries
 +
# SPDX-FileCopyrightText: 2021-2023 Kattni Rembor for Adafruit Industries
 +
# SPDX-FileCopyrightText: 2023 Dan Halbert for Adafruit Industries
 +
#
 +
# SPDX-License-Identifier: MIT
 +
 +
"""CircuitPython Essentials Pin Map Script"""
 +
import microcontroller
 +
import board
 +
try:
 +
    import cyw43  # raspberrypi
 +
except ImportError:
 +
    cyw43 = None
 +
 +
board_pins = []
 +
for pin in dir(microcontroller.pin):
 +
    if (isinstance(getattr(microcontroller.pin, pin), microcontroller.Pin) or
 +
        (cyw43 and isinstance(getattr(microcontroller.pin, pin), cyw43.CywPin))):
 +
        pins = []
 +
        for alias in dir(board):
 +
            if getattr(board, alias) is getattr(microcontroller.pin, pin):
 +
                pins.append(f"board.{alias}")
 +
        # Add the original GPIO name, in parentheses.
 +
        if pins:
 +
            # Only include pins that are in board.
 +
            pins.append(f"({str(pin)})")
 +
            board_pins.append(" ".join(pins))
 +
 +
for pins in sorted(board_pins):
 +
    print(pins)
 +
</syntaxhighlight>
 +
 +
When you run the script on a specific controller you get a text ouput that is the mapping.
 +
 +
== CircuitPython Pin Mapping for Arduino Nano Connect RP2024 ==
 +
 +
<syntaxhighlight lang="python" line='line'>
 +
board.A0 (GPIO26)
 +
board.A1 (GPIO27)
 +
board.A2 (GPIO28)
 +
board.A3 (GPIO29)
 +
board.A4 board.SDA (GPIO12)
 +
board.A5 board.SCL (GPIO13)
 +
board.CS1 board.ESP_CS (GPIO9)
 +
board.D0 board.TX (GPIO0)
 +
board.D1 board.RX (GPIO1)
 +
board.D10 (GPIO5)
 +
board.D11 board.MOSI (GPIO7)
 +
board.D12 board.MISO (GPIO4)
 +
board.D13 board.LED board.SCK (GPIO6)
 +
board.D2 (GPIO25)
 +
board.D3 (GPIO15)
 +
board.D4 (GPIO16)
 +
board.D5 (GPIO17)
 +
board.D6 (GPIO18)
 +
board.D7 (GPIO19)
 +
board.D8 (GPIO20)
 +
board.D9 (GPIO21)
 +
board.ESP_BUSY (GPIO10)
 +
board.ESP_GPIO0 (GPIO2)
 +
board.ESP_RESET (GPIO3)
 +
board.INT1 (GPIO24)
 +
board.MICROPHONE_CLOCK (GPIO23)
 +
board.MICROPHONE_DATA (GPIO22)
 +
board.MISO1 (GPIO8)
 +
board.MOSI1 (GPIO11)
 +
board.SCK1 (GPIO14)
 +
</syntaxhighlight>
 +
 +
== CircuitPython Pin Mapping for Raspberry PI Pico ==
 +
 +
<syntaxhighlight lang="python" line='line'>
 +
board.A0 board.GP26 board.GP26_A0 (GPIO26)
 +
board.A1 board.GP27 board.GP27_A1 (GPIO27)
 +
board.A2 board.GP28 board.GP28_A2 (GPIO28)
 +
board.A3 board.VOLTAGE_MONITOR (GPIO29)
 +
board.GP0 (GPIO0)
 +
board.GP1 (GPIO1)
 +
board.GP10 (GPIO10)
 +
board.GP11 (GPIO11)
 +
board.GP12 (GPIO12)
 +
board.GP13 (GPIO13)
 +
board.GP14 (GPIO14)
 +
board.GP15 (GPIO15)
 +
board.GP16 (GPIO16)
 +
board.GP17 (GPIO17)
 +
board.GP18 (GPIO18)
 +
board.GP19 (GPIO19)
 +
board.GP2 (GPIO2)
 +
board.GP20 (GPIO20)
 +
board.GP21 (GPIO21)
 +
board.GP22 (GPIO22)
 +
board.GP23 board.SMPS_MODE (GPIO23)
 +
board.GP24 board.VBUS_SENSE (GPIO24)
 +
board.GP25 board.LED (GPIO25)
 +
board.GP3 (GPIO3)
 +
board.GP4 (GPIO4)
 +
board.GP5 (GPIO5)
 +
board.GP6 (GPIO6)
 +
board.GP7 (GPIO7)
 +
board.GP8 (GPIO8)
 +
board.GP9 (GPIO9)
 +
</syntaxhighlight>
 +
 
= Install the Mu Editor =
 
= Install the Mu Editor =
  
Line 8: Line 280:
  
 
* On first start up select CircuitPython as Mode
 
* On first start up select CircuitPython as Mode
 +
 +
[[File:Cp3-mu.png|x250px]]
  
 
* Test if it works in the CircuitPython REPL console
 
* Test if it works in the CircuitPython REPL console
  
−
= Installing CircuitPython =
+
[[File:Cp4-mu.png|x250px]]
−
 
 
−
Go to [https://circuitpython.org/downloads circuitpython.org/downloads] and download the version for your board.
 
−
 
 
−
Connect the board to the computer (e.g. Raspberry PI Pico) and the folder RPI-RP2 shows ups in your file system.
 
−
 
 
−
Copy the .uf2 into the folder of the board.
 

Revision as of 22:46, 23 June 2024

Introduction and step by step tutorial from Adafruit

Installing CircuitPython

Go to circuitpython.org/downloads and download the version for your board.

For the Raspberry PI Pico connect the board to the computer and the folder RPI-RP2 shows ups in your file system. For the Arduino Nano Connect RP2040 force the bootloder mode to upload the .uf2 file. Copy the .uf2 into the folder of the board.

Cp01.png Cp02.png

Now you should be able to connect to the board and use the editor.

If you need more help, here is a more detailed description on the installation process at adafruit.com

On the download site there is also a webbased download process - where the browser makes a serial connection to the board.

CircuitPy Drive

After installing CircuitPython on the board and reconnecting the board, it should show up as a USB drive on your computer with the name CircuitPy.

Here you can directly access the code you write and data you safe from your programs.

Cp05-usb-drive.png

As the board is a USB drive do not just unplug it - use "safe remove" feature of your OS.

Cp06-safe-remove.png Cp07-safe-remove.png

Running your first CircuitPython Program

In the file system of the board (that shows up as USB Drive CIRCUITPY) there is a file code.py.

To write your program, open code.py and edit it with your code. Once you safe it, it will be automatically excuted. The file name must be code.py or main.py.

Try it out with the following program. Just use any editor and open code.py. Replace it with the following code and you should see the LED flash. Changes the sleep times. Each time you safe it the new program will be active: 

 1 # write on serial line and blink onbaord LED
 2 import board
 3 import digitalio
 4 import time
 5 
 6 led = digitalio.DigitalInOut(board.LED)
 7 led.direction = digitalio.Direction.OUTPUT
 8 
 9 while True:
10     led.value = False
11     time.sleep(0.8)
12     led.value = True
13     time.sleep(0.2)



 1 # check input, switch LED, write on serial line
 2 import board
 3 import digitalio
 4 from digitalio import DigitalInOut, Direction, Pull
 5 import time
 6 
 7 led = digitalio.DigitalInOut(board.LED)
 8 led.direction = digitalio.Direction.OUTPUT
 9 
10 switch = DigitalInOut(board.D2)
11 switch.direction = Direction.INPUT
12 switch.pull = Pull.UP
13 
14 while True:
15     time.sleep(0.2)
16     if switch.value:
17         led.value = False
18         print("Off")
19     else:
20         led.value = True
21         print("On")

Using Libraries

Here are examples of how to use libraries.

accelerometer of the Arduino Nano Connect RP2024

How to read the accelerometer of the Arduino Nano Connect RP2024.

Download the library (in this case it is in the zip from Adafruit, see Download Project Bundle).

Copy the library folders into the library folder on the USB drive (CIRCUITPY).

Cp08-lib.png Cp09-lib02.png

Now you can use the libraries, e.g. for reading the accelerometer using the adafruit_lsm6ds library. 


 1 # SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries
 2 #
 3 # SPDX-License-Identifier: MIT
 4 import time
 5 import board
 6 from adafruit_lsm6ds.lsm6dsox import LSM6DSOX
 7 
 8 i2c = board.I2C()  # uses board.SCL and board.SDA
 9 # i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
10 sensor = LSM6DSOX(i2c)
11 
12 while True:
13     print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (sensor.acceleration))
14     print("Gyro X:%.2f, Y: %.2f, Z: %.2f radians/s" % (sensor.gyro))
15     print("")
16     time.sleep(0.5)

for more details see: on how to use the onboard IMU of the Arduino Nano RP2040 Connect (LSM6DSOXTR)

Keyboard emulator

for more details on the mouse and keyboard emulator see the Adafruit page

We have also an example, where the IMU of the Arduino Nano Connect RP2040 is read and strings are send to the computer. 

 1 # SPDX-FileCopyrightText: 2018 Kattni Rembor for Adafruit Industries
 2 #
 3 # SPDX-License-Identifier: MIT
 4 
 5 """CircuitPython Essentials HID Keyboard example"""
 6 import time
 7 import board
 8 import digitalio
 9 from digitalio import DigitalInOut, Direction, Pull
10 import usb_hid
11 from adafruit_hid.keyboard import Keyboard
12 from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
13 from adafruit_hid.keycode import Keycode
14 
15 led = digitalio.DigitalInOut(board.LED)
16 led.direction = digitalio.Direction.OUTPUT
17 
18 switch = DigitalInOut(board.D2)
19 switch.direction = Direction.INPUT
20 switch.pull = Pull.UP
21 
22 # The keyboard object!
23 time.sleep(1)  # Sleep for a bit to avoid a race condition on some systems
24 keyboard = Keyboard(usb_hid.devices)
25 keyboard_layout = KeyboardLayoutUS(keyboard)  # We're in the US :)
26 
27 
28 while True:
29     time.sleep(2)
30     if switch.value:
31         led.value = False
32         print("Off")
33     else:
34         led.value = True
35         print("On")
36         keyboard_layout.write("Hi There")  # ...Print the string

Finding your PIN names - Pin mapping script

CircuitPython uses it own names which makes it easier to use the same code on different boards. But this requires you to first find out which PINs on your physical board map to the logical pins in the program code.

There is a pin mapping scriptt avaiable for this at Adafruit. You can download the project bundel there. Here is the script, too. And below are the mappings for the Arduino Nano Connect RP2024 and the Raspberry Pi Pico 

 1 # SPDX-FileCopyrightText: 2020 anecdata for Adafruit Industries
 2 # SPDX-FileCopyrightText: 2021 Neradoc for Adafruit Industries
 3 # SPDX-FileCopyrightText: 2021-2023 Kattni Rembor for Adafruit Industries
 4 # SPDX-FileCopyrightText: 2023 Dan Halbert for Adafruit Industries
 5 #
 6 # SPDX-License-Identifier: MIT
 7 
 8 """CircuitPython Essentials Pin Map Script"""
 9 import microcontroller
10 import board
11 try:
12     import cyw43  # raspberrypi
13 except ImportError:
14     cyw43 = None
15 
16 board_pins = []
17 for pin in dir(microcontroller.pin):
18     if (isinstance(getattr(microcontroller.pin, pin), microcontroller.Pin) or
19         (cyw43 and isinstance(getattr(microcontroller.pin, pin), cyw43.CywPin))):
20         pins = []
21         for alias in dir(board):
22             if getattr(board, alias) is getattr(microcontroller.pin, pin):
23                 pins.append(f"board.{alias}")
24         # Add the original GPIO name, in parentheses.
25         if pins:
26             # Only include pins that are in board.
27             pins.append(f"({str(pin)})")
28             board_pins.append(" ".join(pins))
29 
30 for pins in sorted(board_pins):
31     print(pins)

When you run the script on a specific controller you get a text ouput that is the mapping.

CircuitPython Pin Mapping for Arduino Nano Connect RP2024

 1 board.A0 (GPIO26)
 2 board.A1 (GPIO27)
 3 board.A2 (GPIO28)
 4 board.A3 (GPIO29)
 5 board.A4 board.SDA (GPIO12)
 6 board.A5 board.SCL (GPIO13)
 7 board.CS1 board.ESP_CS (GPIO9)
 8 board.D0 board.TX (GPIO0)
 9 board.D1 board.RX (GPIO1)
10 board.D10 (GPIO5)
11 board.D11 board.MOSI (GPIO7)
12 board.D12 board.MISO (GPIO4)
13 board.D13 board.LED board.SCK (GPIO6)
14 board.D2 (GPIO25)
15 board.D3 (GPIO15)
16 board.D4 (GPIO16)
17 board.D5 (GPIO17)
18 board.D6 (GPIO18)
19 board.D7 (GPIO19)
20 board.D8 (GPIO20)
21 board.D9 (GPIO21)
22 board.ESP_BUSY (GPIO10)
23 board.ESP_GPIO0 (GPIO2)
24 board.ESP_RESET (GPIO3)
25 board.INT1 (GPIO24)
26 board.MICROPHONE_CLOCK (GPIO23)
27 board.MICROPHONE_DATA (GPIO22)
28 board.MISO1 (GPIO8)
29 board.MOSI1 (GPIO11)
30 board.SCK1 (GPIO14)

CircuitPython Pin Mapping for Raspberry PI Pico

 1 board.A0 board.GP26 board.GP26_A0 (GPIO26)
 2 board.A1 board.GP27 board.GP27_A1 (GPIO27)
 3 board.A2 board.GP28 board.GP28_A2 (GPIO28)
 4 board.A3 board.VOLTAGE_MONITOR (GPIO29)
 5 board.GP0 (GPIO0)
 6 board.GP1 (GPIO1)
 7 board.GP10 (GPIO10)
 8 board.GP11 (GPIO11)
 9 board.GP12 (GPIO12)
10 board.GP13 (GPIO13)
11 board.GP14 (GPIO14)
12 board.GP15 (GPIO15)
13 board.GP16 (GPIO16)
14 board.GP17 (GPIO17)
15 board.GP18 (GPIO18)
16 board.GP19 (GPIO19)
17 board.GP2 (GPIO2)
18 board.GP20 (GPIO20)
19 board.GP21 (GPIO21)
20 board.GP22 (GPIO22)
21 board.GP23 board.SMPS_MODE (GPIO23)
22 board.GP24 board.VBUS_SENSE (GPIO24)
23 board.GP25 board.LED (GPIO25)
24 board.GP3 (GPIO3)
25 board.GP4 (GPIO4)
26 board.GP5 (GPIO5)
27 board.GP6 (GPIO6)
28 board.GP7 (GPIO7)
29 board.GP8 (GPIO8)
30 board.GP9 (GPIO9)

Install the Mu Editor

Follow the instructions for installting the Mu Editor.

  • Install it on your system
  • On first start up select CircuitPython as Mode

Cp3-mu.png

  • Test if it works in the CircuitPython REPL console

Cp4-mu.png

Retrieved from "http://www.sketching-with-hardware.org/wiki/index.php?title=Circuitpython&oldid=1782"