pyb — functions related to the board¶
pyb module contains specific functions related to the board.
Return True if USB is connected as a serial device, False otherwise.
This function is deprecated. Use pyb.USB_VCP().isconnected() instead.
hid((buttons, x, y, z))¶
Takes a 4-tuple (or list) and sends it to the USB host (the PC) to signal a HID mouse-motion event.
This function is deprecated. Use
Print out lots of information about the board.
Set the filename of the main script to run after boot.py is finished. If this function is not called then the default file main.py will be executed.
It only makes sense to call this function from within boot.py.
mount(device, mountpoint, *, readonly=False, mkfs=False)¶
This function is deprecated. Mounting and unmounting devices should be performed by
Mount a block device and make it available as part of the filesystem.
devicemust be an object that provides the block protocol. (The following is also deprecated. See
uos.AbstractBlockDevfor the correct way to create a block device.)
readblocks(self, blocknum, buf)
writeblocks(self, blocknum, buf)(optional)
writeblocksshould copy data between
bufand the block device, starting from block number
blocknumon the device.
bufwill be a bytearray with length a multiple of 512. If
writeblocksis not defined then the device is mounted read-only. The return value of these two functions is ignored.
countshould return the number of blocks available on the device.
sync, if implemented, should sync the data on the device.
mountpointis the location in the root of the filesystem to mount the device. It must begin with a forward-slash.
True, then the device is mounted read-only, otherwise it is mounted read-write.
True, then a new filesystem is created if one does not already exist.
Get or set the UART object where the REPL is repeated on.
Return a 30-bit hardware generated random number.
Sync all file systems.
Returns a string of 12 bytes (96 bits), which is the unique ID of the MCU.
usb_mode([modestr, ]port=-1, vid=0xf055, pid=-1, msc=(), hid=pyb.hid_mouse, high_speed=False)¶
If called with no arguments, return the current USB mode as a string.
If called with modestr provided, attempts to configure the USB mode. The following values of modestr are understood:
None: disables USB
'VCP': enable with VCP (Virtual COM Port) interface
'MSC': enable with MSC (mass storage device class) interface
'VCP+MSC': enable with VCP and MSC
'VCP+HID': enable with VCP and HID (human interface device)
'VCP+MSC+HID': enabled with VCP, MSC and HID (only available on PYBD boards)
For backwards compatibility,
'CDC'is understood to mean
'VCP'(and similarly for
The port parameter should be an integer (0, 1, …) and selects which USB port to use if the board supports multiple ports. A value of -1 uses the default or automatically selected port.
The vid and pid parameters allow you to specify the VID (vendor id) and PID (product id). A pid value of -1 will select a PID based on the value of modestr.
If enabling MSC mode, the msc parameter can be used to specify a list of SCSI LUNs to expose on the mass storage interface. For example
If enabling HID mode, you may also specify the HID details by passing the hid keyword parameter. It takes a tuple of (subclass, protocol, max packet length, polling interval, report descriptor). By default it will set appropriate values for a USB mouse. There is also a
pyb.hid_keyboardconstant, which is an appropriate tuple for a USB keyboard.
The high_speed parameter, when set to
True, enables USB HS mode if it is supported by the hardware.
- class Accel – accelerometer control
- class ADC – analog to digital conversion
- class CAN – controller area network communication bus
- class DAC – digital to analog conversion
- class ExtInt – configure I/O pins to interrupt on external events
- class Flash – access to built-in flash storage
- class I2C – a two-wire serial protocol
- class LCD – LCD control for the LCD touch-sensor pyskin
- class LED – LED object
- class Pin – control I/O pins
- class PinAF – Pin Alternate Functions
- class RTC – real time clock
- class Servo – 3-wire hobby servo driver
- class SPI – a master-driven serial protocol
- class Switch – switch object
- class Timer – control internal timers
- class TimerChannel — setup a channel for a timer
- class UART – duplex serial communication bus
- class USB_HID – USB Human Interface Device (HID)
- class USB_VCP – USB virtual comm port