📑 Example Usage

The pycubed.py library is always invoked by importing the "cubesat" object as shown below:

from pycubed import cubesat

This is usually done at the start of your main.py file (or whatever script you're writing). But it also makes it easy to interact with the board from the REPL:

>>> from pycubed import cubesat
[ERROR][SD Card] no SD card
[WARNING][RADIO #2] Failed to find rfm9x with expected version -- check wiring
>>>

However you are working with the board, you should always start with:

from pycubed import cubesat if you intend to use the pycubed.py helper library.

from pycubed import cubesat
print(cubesat.hardware)

Simple property that lets you set the color of the RGB LED using a tuple in the format of (RED,GREEN,BLUE). Values can only be 0→255. The full adafruit_neopixel library is accessible from the cubesat.neopixel object. See adafruit_neopixel→ for more details.

from pycubed import cubesat
cubesat.RGB = (0,255,0) # sets the LED to pure green
cubesat.RGB = (0,0,0) # turns the LED off
cubesat.RGB = (255,255,255) # this sets the LED to white (consuming the most power)

print(cubesat.RGB) # returns the current LED color value

cubesat.neopixel.brightness = 0.5 # sets the LED brightness. Default is 0.2, max is 1

Returns a float of the CPU temperature in Celsius measured on-chip by the SAMD51

from pycubed import cubesat
temp = cubesat.micro.cpu.temperature # returns the temperature in celcius for the SAMD51

The IMU is capable of many other functions as well.
See See BMX160 datasheet for more details:
🗄Component Datasheets

from pycubed import cubesat
temp = cubesat.temperature # Celsius

from pycubed import cubesat

x_accel, y_accel, z_accel = cubesat.acceleration # m/s^2

from pycubed import cubesat

x_mag, y_mag, z_mag = cubesat.magnetic # uT

from pycubed import cubesat

x_gyro, y_gyro, z_gyro = cubesat.gyro # degrees/second

Returns a float of the battery voltage in volts. Measured with the SAMD51 16-bit ADC using a 316/110 voltage divider

from pycubed import cubesat
vbatt = cubesat.battery_voltage

Returns a float of the charge current in mA. Measured with the SAMD51 16-bit ADC of the "L1 Prog" analog output from the LTC4121 energy harvesting circuit. See ☀️PyCubed Energy Harvesting and LTC4121 datasheet for more details: 🗄Component Datasheets

from pycubed import cubesat
ichrg = cubesat.charge_current

Returns a float of the system voltage right before the main 3.3V regulator. Value returned from the ADM1176 power-monitoring IC over I2C. See ADM1176 datasheet for more details: 🗄Component Datasheets, and CircuitPython_ADM1176 library.

from pycubed import cubesat
vsys = cubesat.system_voltage

Returns a float of the system current flowing into the main 3.3V regulator. Value returned from the ADM1176 power-monitoring IC over I2C. See ADM1176 datasheet for more details: 🗄Component Datasheets, and CircuitPython_ADM1176 library.

from pycubed import cubesat
isys = cubesat.current_draw

The specific burn wire parameters need to be tuned to the specific system. This burn wire parameters are to configured by directly editing the pycubed.py text file. See 🔥PyCubed Burn Wire Info & Usage for more details.

See 💾Selecting an SD card for details on which cards to use, and 📂SD Card for code examples.

USB charging is disabled by default when the pycubed.py library is invoked.

from pycubed import cubesat
print(cubesat.charge_batteries)

from pycubed import cubesat
# enable charging (green LED will blink if no battery detected)
cubesat.charge_batteries=True
# disable charging 
cubesat.charge_batteries=False

from pycubed import cubesat
cubesat.usb.charging_current=8 #400mA

See Example Flight Software for an introduction to using the radio and the advanced example for common usage patterns. See 📁Radio for coding examples.

See 📁GPS example for a demo using a commercial GPS module.

See 📋PyCubed NVM Bit Map & Usage for more details.

from pycubed import cubesat

bootcnt = cubesat.boot_count

from pycubed import cubesat

# set the boot_count status byte to 0
cubesat.reset_boot_count

📚 pycubed.py code