stubber.tools.pyboard

pyboard interface

This module provides the Pyboard class, used to communicate with and control a MicroPython device over a communication channel. Both real boards and emulated devices (e.g. running in QEMU) are supported. Various communication channels are supported, including a serial connection, telnet-style network connection, external process connection.

Example usage:

import pyboard pyb = pyboard.Pyboard(‘/dev/ttyACM0’)

Or:

pyb = pyboard.Pyboard(‘192.168.1.1’)

Then:

pyb.enter_raw_repl() pyb.exec(‘import pyb’) pyb.exec(‘pyb.LED(1).on()’) pyb.exit_raw_repl()

Note: if using Python2 then pyb.exec must be written as pyb.exec_. To run a script from the local machine on the board and print out the results:

import pyboard pyboard.execfile(‘test.py’, device=’/dev/ttyACM0’)

This script can also be run directly. To execute a local script, use:

./pyboard.py test.py

Or:

python pyboard.py test.py

Module Contents

Classes

TelnetToSerial
ProcessToSerial	Execute a process and emulate serial connection using its stdin/stdout.
ProcessPtyToTerminal	Execute a process which creates a PTY and prints slave PTY as
Pyboard

Functions

stdout_write_bytes(b)
execfile(filename[, device, baudrate, user, password])
filesystem_command(pyb, args)
main()

Attributes

stdout
_injected_import_hook_code

stubber.tools.pyboard.stdout

stubber.tools.pyboard.stdout_write_bytes(b)

exception stubber.tools.pyboard.PyboardError

Bases: Exception

Common base class for all non-exit exceptions.

class stubber.tools.pyboard.TelnetToSerial(ip, user, password, read_timeout=None)

__del__()

close()

read(size=1)

write(data)

inWaiting()

class stubber.tools.pyboard.ProcessToSerial(cmd)

Execute a process and emulate serial connection using its stdin/stdout.

close()

read(size=1)

write(data)

inWaiting()

class stubber.tools.pyboard.ProcessPtyToTerminal(cmd)

Execute a process which creates a PTY and prints slave PTY as first line of its output, and emulate serial connection using this PTY.

close()

read(size=1)

write(data)

inWaiting()

class stubber.tools.pyboard.Pyboard(device, baudrate=115200, user='micro', password='python', wait=0, exclusive=True)

close()

read_until(min_num_bytes, ending, timeout=10, data_consumer=None)

enter_raw_repl(soft_reset=True)

exit_raw_repl()

follow(timeout, data_consumer=None)

raw_paste_write(command_bytes)

exec_raw_no_follow(command)

exec_raw(command, timeout=10, data_consumer=None)

eval(expression)

exec_(command, data_consumer=None)

execfile(filename)

get_time()

fs_ls(src)

fs_cat(src, chunk_size=256)

fs_get(src, dest, chunk_size=256)

fs_put(src, dest, chunk_size=256)

fs_mkdir(dir)

fs_rmdir(dir)

fs_rm(src)

stubber.tools.pyboard.execfile(filename, device='/dev/ttyACM0', baudrate=115200, user='micro', password='python')

stubber.tools.pyboard.filesystem_command(pyb, args)

stubber.tools.pyboard._injected_import_hook_code = Multiline-String

Show Value

import uos, uio
class _FS:
  class File(uio.IOBase):
    def __init__(self):
      self.off = 0
    def ioctl(self, request, arg):
      return 0
    def readinto(self, buf):
      buf[:] = memoryview(_injected_buf)[self.off:self.off + len(buf)]
      self.off += len(buf)
      return len(buf)
  mount = umount = chdir = lambda *args: None
  def stat(self, path):
    if path == '_injected.mpy':
      return tuple(0 for _ in range(10))
    else:
      raise OSError(-2) # ENOENT
  def open(self, path, mode):
    return self.File()
uos.mount(_FS(), '/_')
uos.chdir('/_')
from _injected import *
uos.umount('/_')
del _injected_buf, _FS

stubber.tools.pyboard.main()