pyb --- pyboard 関連の関数

pyb は puboard に固有の関数を提供します(訳注: 元々は pyboard 用ですが、似たアーキテクチャ、特に STM32 系の MCU を載せたボードではサポートされていることが多いです)。

時間関連の関数

pyb.delay(ms)

与えたミリ秒数だけ遅延します。

pyb.udelay(us)

与えたマイクロ秒数だけ遅延します。

pyb.millis()

ボードが最後にリセットされてからのミリ秒数を返します。

結果は常に MicroPython の smallint (31ビットの符号付き数値)なので、2^30 ミリ秒(約12.4日)が経過すると、負の数が返され始めます。

pyb.stop() が発行された場合、この機能をサポートするハードウェアカウンタが「睡眠」状態の継続のために一時停止します。これは pyb.elapsed_millis() の結果に影響します。

pyb.micros()

ボードが最後にリセットされてからのマイクロ秒数を返します。

結果は常に MicroPython の smallint (31ビットの符号付き数値)なので、2^30マイクロ秒(約17.8分)後に負の数が返され始めます。

pyb.stop() が発行された場合、この機能をサポートするハードウェアカウンタが「睡眠」状態の継続のために一時停止します。これは pyb.elapsed_millis() の結果に影響します。

pyb.elapsed_millis(start)

start から経過したミリ秒数を返します。

この関数はカウンタラップを処理し、常に正の数を返します。これは、最大約12.4日の期間を測定するために使用できることを意味します。

サンプルコード:

start = pyb.millis()
while pyb.elapsed_millis(start) < 1000:
    # 何等かの操作の実行

pyb.elapsed_micros(start)

start から経過したマイクロ秒数を返します。

この関数はカウンタラップを処理し、常に正の数を返します。これは、最大約17.8分の期間を測定するために使用できることを意味します。

サンプルコード:

start = pyb.micros()
while pyb.elapsed_micros(start) < 1000:
    # 何等かの操作の実行
    pass

リセット関連の関数

pyb.hard_reset()

外部 RESET ボタンを押すのと同じように、pyboard をリセットします。

pyb.bootloader()

BOOT* ピンなしでブートローダを起動します。

pyb.fault_debug(value)

ハードフォルト(hard-fault)デバッグを有効または無効にします。ハードフォルトとは、無効なメモリアクセスのように、基盤となるシステムに致命的なエラーがある場合のことです。

value 引数が False の場合、ハードフォルトがあると、ボードは自動的にリセットされます。

value 引数が True の場合、ボードにハードフォルトがあると、レジスタとスタックトレースを表示してから、LED を無期限に点滅させます。

デフォルト値は無効、つまり自動的にリセットされます。

割り込み関連の関数

pyb.disable_irq()

割り込み要求を禁止します。前のIRQの状態の無効/有効に対応してそれぞれ False/True を返します。この戻り値をenable_irqに渡して IRQ を元の状態に戻せます。

pyb.enable_irq(state=True)

割り込み要求を有効にします。 state が True の場合(デフォルト値)、その後の IRQ が有効になります。 state が False の場合、その後の IRQ が無効になります。この関数の最も一般的な使い方は、クリティカルセクションを終了するために disable_irq が返した値を渡すことです。

電力関連の関数

pyb.freq([sysclk[, hclk[, pclk1[, pclk2]]]])

引数を与えなかった場合、クロック周波数のタプル (sysclk, hclk, pclk1, pclk2) を返しま。これらは以下に対応します。

• sysclk：CPUの周波数
• hclk: AHB バス、コアメモリ、DMA の周波数
• pclk1: APB1バスの周波数
• pclk2: APB2バスの周波数

引数を与えと、関数は CPU の周波数を設定し、追加の引数が与えられるとバスを設定します。周波数は Hz で与えます。たとえば freq(120000000) は sysclk (CPU 周波数) を 120 MHz に設定します。すべての値がサポートされているわけではなく、指定された値以下の最大のサポート周波数が選択されます。

サポートしている sysclk 周波数(MHz) は 8, 16, 24, 30, 32, 36, 40, 42, 48, 54, 56, 60, 64, 72, 84, 96, 108, 120, 144, 168 です。

hclk の最大周波数は 168MHz、pclk1 の最大周波数は 42MHz、pclk2 のは最大周波数は 84MHzです。周波数をこれらの値より上に設定しないでください。

hclk, pclk1, pclk2 の周波数は、プリスケーラ(分周器)を使用して sysclk の周波数から導き出されます。hclk でサポートされている プリスケーラは 1, 2, 4, 8, 16, 64, 128, 256, 512 です。pclk1 と pclk2 でサポートされているプリスケーラは 1, 2, 4, 8 です。プリスケーラは要求された周波数に最もよく合うように選択されます。

8MHz の sysclk 周波数は HSE (外部水晶)を直接使用し、16MHz は HSI (内部発振器)を直接使用します。より高い周波数では、HSE を使って PLL (位相同期ループ)を駆動して、PLL の出力を使います。

USB が有効になっている間に周波数を変更すると、USB の信頼性が低下する可能性があります。USB 周辺機器を起動する前に、boot.py で周波数を変更するのが最善です。また、sysclk の周波数が 36MHz より低いと、USB は正しく機能しません。

pyb.wfi()

内部または外部割り込みを待ちます。

これは、(MCU の内部または外部にかかわらず)割り込みが発生するまで MCU の消費電力を削減する wfi 命令を実行し、その時点で実行は継続します。システムティックの割り込みは1ミリ秒(1000Hz)に１回発生するため、この関数は最大 1ms ブロックします。

pyb.stop()

pyboard を「スリープ」状態にします。

これにより、消費電力が 500 µA 未満になります。このスリープ状態から復帰するには、外部割り込みまたはリアルタイムクロックイベントが必要です。目が覚めると実行は中断した所から再開されます。

リアルタイムクロックのウェイクアップイベントを設定する方法については rtc.wakeup() を参照してください。

pyb.standby()

pyboard を「ディープスリープ」状態にします。

これにより、消費電力が 50 µA 未満になります。このスリープ状態から復帰するには、リアルタイムクロックイベント、または X1 (PA0=WKUP)か X18 (PC13=TAMP1) での外部割り込みが必要です。起動するとシステムはハードリセットされます。

リアルタイムクロックのウェイクアップイベントを設定する方法については rtc.wakeup() を参照してください。

その他の関数

pyb.have_cdc()

USB がシリアルデバイスとして接続されていれば True を、そうでなければ False を返します。

注釈

この関数は非推奨です。代わりに pyb.USB_VCP().isconnected() を使ってください。

pyb.hid((buttons, x, y, z))

4項目のタプル(またはリスト)を取り、それを USB ホスト(PC)に送信して HID マウスモーションイベントを通知します。

注釈

この関数は非推奨です。代わりに pyb.USB_HID.send() を使ってください。

pyb.info([dump_alloc_table])

ボードについてのたくさんの情報を表示します。

pyb.main(filename)

boot.py が完了した後に実行するメインスクリプトのファイル名を設定します。この関数が呼び出されないと、デフォルトのファイル main.py が実行されます。

boot.py の中からこの関数を呼び出すことだけが理にかなっています。

pyb.mount(device, mountpoint, *, readonly=False, mkfs=False)

注釈

この関数は非推奨です。デバイスのマウントとマウント解除には、代わりに os.mount() と os.umount() を使ってください。

ブロックデバイスをマウントしてファイルシステムの一部として利用できるようにします。 device はブロックプロトコルを提供するオブジェクトでなければなりません。(以下も非推奨です。ブロックデバイスを作成する正しい方法については os.AbstractBlockDev を参照してください。）

• readblocks(self, blocknum, buf)
• writeblocks(self, blocknum, buf) (オプション)
• count(self)
• sync(self) (オプション)

readblocks と writeblocks は buf とブロックデバイスの間でデータをコピーするもので、デバイスのブロック番号 blocknum から始まります。 buf は 512 の倍数の長さを持つ bytearray です。 writeblocks が定義されていなければ、デバイスは読み取り専用でマウントされます。これら2つの関数の戻り値は無視されます。

count はデバイスで利用可能なブロック数を返します。sync が実装されている場合、この関数はデバイス上のデータを同期します。

パラメータ mountpoint は、デバイスをマウントするためのファイルシステムのルート内の場所です。それはスラッシュ記号で始まらなければなりません。

readonly が True であれば、デバイスは読み取り専用でマウントされ、それ以外の場合は、読み書きができるようマウントされます。

mkfs が True である場合、ファイルシステムが存在しない場合は、新しいファイルシステムが作成されます。

pyb.repl_uart(uart)

REPL が繰り返される UART オブジェクトを取得または設定します。

pyb.rng()

30ビットのハードウェア生成乱数を返します。

pyb.sync()

すべてのファイルシステムを同期します。

pyb.unique_id()

MCU の一意な ID である12バイト(96ビット)の文字列を返します。

pyb.usb_mode([modestr, ]port=-1, vid=0xf055, pid=-1, msc=(), hid=pyb.hid_mouse, high_speed=False)

引数なしで呼び出された場合は、現在の USB モードを文字列として返します。

modestr を指定して呼び出した場合、USB モードの設定を試みます。 modestr の値には次のものがあります:

• None: USB を無効化
• 'VCP': VCP (仮想 COM ポート)インタフェースを有効化
• 'MSC': MSC (マスストレージデバイスクラス)インタフェースを有効化
• 'VCP+MSC': VCP と MSC を有効化
• 'VCP+HID': VCP と HID (ヒューマンインタフェースデバイス)を有効化
• 'VCP+MSC+HID': enabled with VCP, MSC and HID (only available on PYBD boards)

後方互換性のために、 'CDC' は 'VCP' を意味すると解釈されます('CDC+MSC' と 'CDC+HID' も同様です)。

port パラメータには整数(0, 1, ...)を指定し、ボードが複数の USB ポートをサポートしている場合に使う USB ポートを選択します。値が -1 である場合は、デフォルトまたは自動的に選択された USB ポートを使います。

vid と pid パラメータは、VID (ベンダID)と PID (プロダクトID)を指定します。 pid の値が -1 である場合は modestr の値に基づいて PID を選択します。

MSC モードを有効にする場合、 msc パラメーターを使ってマスストレージインターフェイスで公開する SCSI LUN のリストを指定できます。たとえば msc=(pyb.Flash(), pyb.SDCard()) と指定します。

HID モードを有効にする場合、 hid キーワードパラメータを渡して HID の詳細を指定することもできます。それは (subclass, protocol, max packet length, polling interval, report descriptor) のタプルを引数に取ります。デフォルトでは USB マウスに適切な値を設定します。USB キーボードに適したタプルである pyb.hid_keyboard 定数もあります。

high_speed パラメータを True に設定すると、ハードウェアでサポートされていれば USB HS モードが有効になります。

定数

pyb.hid_mouse

pyb.hid_keyboard

(サブクラス, プロトコル, 最大パケット長, ポーリング間隔, レポートデスクリプタ) のタプルで、USB マウスやキーボードに適切な値を設定するためのもの。

クラス

• クラス Accel - 加速度センサー制御
• クラス ADC -- アナログ-デジタル変換
• class CAN -- controller area network communication bus
• class DAC -- digital to analog conversion
• class ExtInt -- configure I/O pins to interrupt on external events
• クラス Flash -- 内蔵フラッシュストレージへのアクセス
• クラス I2C -- ２線式シリアルプロトコル
• class LCD -- LCD control for the LCD touch-sensor pyskin
• クラス LED -- LED オブジェクト
• クラス Pin -- I/O ピンの制御
• class PinAF -- Pin Alternate Functions
• クラス RTC -- リアルタイムクロック
• class Servo -- 3-wire hobby servo driver
• class SPI -- a controller-driven serial protocol
• class Switch -- スイッチオブジェクト
• class Timer -- control internal timers
• class TimerChannel --- setup a channel for a timer
• クラス UART -- 二重シリアル通信バス
• class USB_HID -- USB Human Interface Device (HID)
• class USB_VCP -- USB virtual comm port