M5Unified ライブラリ関連データ定義

Boards

M5.getBoard()

M5.getBoard () で取得可能な開発ボードタイプの列挙値：

namespace boards
  { // 既存のボード番号を変更せずに値を追加する際は注意してください。
    enum board_t
    { board_unknown = 0
    , board_M5Stack
    , board_M5StackCore2
    , board_M5StickC
    , board_M5StickCPlus
    , board_M5StickCPlus2
    , board_M5StackCoreInk
    , board_M5Paper
    , board_M5Tough
    , board_M5Station
    , board_M5StackCoreS3
    , board_M5AtomS3
    , board_M5Dial
    , board_M5DinMeter
    , board_M5Cardputer
    , board_M5AirQ
    , board_M5VAMeter
    , board_M5StackCoreS3SE
    , board_M5AtomS3R
    , board_M5PaperS3
    , board_M5CoreMP135
    , board_M5StampPLC
    , board_M5Tab5
/// non display boards
    , board_M5AtomLite = 128
    , board_M5ATOM **attribute** ((deprecated)) = board_M5AtomLite
    , board_M5Atom **attribute** ((deprecated)) = board_M5AtomLite
    , board_M5AtomPsram
    , board_M5AtomU
    , board_M5Camera
    , board_M5TimerCam
    , board_M5StampPico
    , board_M5StampC3
    , board_M5StampC3U
    , board_M5StampS3
    , board_M5AtomS3Lite
    , board_M5AtomS3U
    , board_M5Capsule
    , board_M5NanoC6
    , board_M5AtomMatrix
    , board_M5AtomEcho
    , board_M5AtomS3RExt
    , board_M5AtomS3RCam
/// external displays
    , board_M5AtomDisplay = 192
    , board_M5ATOMDisplay = board_M5AtomDisplay
    , board_M5UnitLCD
    , board_M5UnitOLED
    , board_M5UnitMiniOLED
    , board_M5UnitGLASS
    , board_M5UnitGLASS2
    , board_M5UnitRCA
    , board_M5ModuleDisplay
    , board_M5ModuleRCA
    , board_FrameBuffer = 512
    };
  } 

Configs

M5.config()

グローバル設定パラメータ

パラメータ名	型	説明	デフォルト値	適用条件
serial_baudrate	uint32_t	USB シリアルボーレート	115200	Arduino-esp32 プラットフォームのみ
clear_display	bool	起動時に画面クリアするか	true	ディスプレイ搭載機器のみ
output_power	bool	外部 5V 出力スイッチ	true	AXP192 チップ搭載機器のみ
pmic_button	bool	PMIC ボタンを有効化するか	true	AXP192 チップ搭載機器のみ
internal_imu	bool	内蔵 IMU を有効化するか	true	IMU モジュール搭載機器のみ
internal_rtc	bool	内蔵 RTC を使用するか	true	RTC モジュール搭載機器のみ
internal_mic	bool	内蔵マイクを使用するか	true	マイク搭載機器のみ
internal_spk	bool	内蔵スピーカーを使用するか	true	スピーカー搭載機器のみ
external_imu	bool	外部 IMU / 加速度センサユニットを使用するか	false	接続可能機器： Unit IMU Unit Accel Unit Mini IMU Unit Mini IMU Pro
external_rtc	bool	外部 RTC ユニットを使用するか	false	接続可能機器： Unit RTC
disable_rtc_irq	bool	起動時 RTC IRQ ビットを無効にするか	true	RTC モジュール搭載機器のみ
led_brightness	uint8_t	内蔵 LED 輝度 (0-255)	0	単色 LED 機器のみ (RGB 非対応)

external_speaker

外部スピーカー有効化パラメータ。次のいずれかを使用、external_speakerはexternal_speaker.<device_name>形式。

パラメータ名	型	説明	デフォルト値	適用条件
external_speaker_value	uint16_t	外部スピーカー利用・ビット別有効化	0x00	下記構造体メンバ定義参照
external_speaker	struct	外部スピーカー利用、メンバ (device_name) 一覧：（特記以外は 1 ビット占有） module_display module_rca hat_spk atomic_spk hat_spk2 atomic_echo reserve (2 ビットリザーブ)	0x00	対応メンバー機器接続可能機器： Hat SPK Hat SPK2 Atomic Echo Base Atomic SPK Base

external_display

外部ディスプレイ有効化パラメータ。次のいずれかを使用、external_displayはexternal_display.<device_name>形式。

パラメータ名	型	説明	デフォルト値	適用条件
external_display_value	uint16_t	外部ディスプレイ利用・ビット別有効化	0xFFFF	下記構造体メンバ定義参照
external_display	struct	外部ディスプレイ利用、メンバ (device_name) 一覧：（特記以外は 1 ビット占有） module_display atom_display unit_oled unit_mini_oled unit_lcd unit_glass unit_glass2 unit_rca module_rca reserve (7 ビットリザーブ)	0xFFFF	対応メンバー機器

M5.Speaker.config()

スピーカー設定パラメータ

パラメータ名	型	説明	デフォルト値	備考
pin_data_out	int	I2S データ出力ピン (スピーカー)	-1	GPIO ピン番号指定必要
pin_bck	int	I2S ビット / シリアルクロックピン (BCK/SCLK)	-1
pin_mck	int	I2S マスタークロックピン (MCLK)	-1
pin_ws	int	I2S チャンネルセレクトピン (WS/LRCK)	-1
sample_rate	uint32_t	サンプリングレート (Hz)	48000
stereo	bool	ステレオ有効化	false
buzzer	bool	ブザー出力有効化	false	有効化時は data_out ピンのみ
use_dac	bool	内蔵 DAC 出力有効化	false	有効化時は data_out ピンのみ、ESP32 は I2S_NUM_0、GPIO25/26 のみ
dac_zero_level	uint8_t	DAC ゼロ基準値	0	0 は自動調整
magnification	uint8_t	出力値拡大倍率	16
dma_buf_len	size_t	I2S DMA バッファ長	256	最大 1024
dma_buf_count	size_t	I2S DMA バッファ数	8
task_priority	uint8_t	オーディオ再生タスク優先度	2
task_pinned_core	uint8_t	オーディオタスク CPU コア固定値	-1
i2s_port	i2s_port_t	使用 I2S ポート	I2S_NUM_0	I2S0 または I2S1 指定可能

Buttons

各モデル機器のボタン GPIO マッピング：

デバイス名	BtnA	BtnB	BtnC	BtnPWR	BtnEXT
M5Basic/Gray/Go/Fire	G39	G38	G37	-	-
M5Core2	TouchA	TouchB	TouchC		-
M5Stick C/CPlus	G39	G37	-	AXP192	-
M5StickCPlus2	G37	G39	G35	-	-
M5CoreInk	G37 (Up)	G38 (Press)	G39 (Down)	G27	G5
M5Paper	G37 (Up)	G38 (Press)	G39 (Down)	-	-
M5Station	G37	G38	G39	AXP192	-
M5Tough	-	-	-	AXP192	-
M5AirQ	G0	G8	-	-	-
M5Atom-Lite/Matrix	G39	-	-	-	-
M5AtomS3/S3-Lite	G41	-	-	-	-
M5Capsule	G42	-	-	-	-
M5Cardputer	G0	-	-	-	-
M5Dial	G42	-	-	-	-
M5DinMeter	G42	-	-	-	-
M5StampPico	G39	-	-	-	-
M5StampC3/C3U	G3	-	-	-	-
M5StampS3/S3A	G0	-	-	-	-
M5StamPLC	P2	P1	P0	-	-

Next 1. Arduino環境設定 - 1. Arduino IDEインストール

1. Arduino環境設定

2. デバイス＆サンプル

Tab5

PowerHub

Basic/Gray

M5GO

Fire

Core2/Core2 For AWS

CoreS3

Tough

Atom-Lite / Atom-Matrix

AtomS3 / AtomS3-Lite

Atom EchoS3R

Dial

Air Quality

DinMeter

Capsule