Arduino core for the ESP32 リファレンス
はじめに
このリファレンスは、Arduino core for the ESP32の関数やライブラリの使い方をまとめたものです。無保証です。間違いや改善点などは、お知らせいただけるとありがたいです。
全ての関数やメソッドを網羅しているわけではなく、スケッチ例などに出てくるものを中心に、選択したものです。
Arduino core for the ESP32は、変更が多いのと、実際には動作させず、ソースを読んだ結果のものが多いので、最新版とは動作が異なったり、私の解釈が間違えている可能性も高いので、利用には注意してください。
現状は、スケッチ例で利用されているものを少しずつ記述しているだけなので、以下に記載のない関数やライブラリもたくさんあります。
Arduino本体のリファレンスの日本語訳はこちらです。
リファレンス
cores
ESP32を再起動する。
ESP32のMACアドレスを取得する。
ESP32のチップモデルを取得する。
ESP32のチップリビジョンを取得する。
ESP32のチップのコア数を取得する。
DAC(Digital Analog Converter)出力。
NTPサーバと、ローカルのタイムゾーンを設定する(オフセット指定)。
NTPサーバと、ローカルのタイムゾーンを設定する(タイムゾーン指定)。
ローカル時刻を取得する。
タイマーの初期設定を行う。
タイマーを開始する。
タイマーを停止する。
タイマー割り込みが発生したときに実行する関数を登録する。
タイマーの設定値(割り込みのタイミング)を設定する。
タイマーの値(現在値)を設定する。
LED PWMで利用するチャネルを設定する。
LED PWMで利用するピンとチャネルを結びつける。
LED PWMで利用するピンとチャネルの結びつきを解除する。
LED PWMを利用して、指定したデューティ比でPWM出力する。
LED PWMを利用して、指定した周波数をPWM出力する。
LED PWMを利用して、指定した音階をPWM出力する。
LED PWMのチャネルに指定したデューティ比を取得する。
LED PWMのチャネルに指定した周波数を取得する。
シグマデルタ変調を設定する。
シグマデルタ変調で利用するピンとチャネルを結びつける。
シグマデルタ変調で利用するピンとチャネルを結びつきを解除する。
シグマデルタ変調を利用して、指定したデューティ比で出力する。
シグマデルタ変調のチャネルに指定したデューティ比を取得する。
タッチセンサの値を読み取る。
タッチセンサに触れたときに実行する関数を登録する。
ホールセンサの値を読み取る。
指定したGPIOピンに対する割り込みハンドラを定義する。
ライブラリ
OTAアップデートサービスを開始する。
OTAアップデート時のコマンドを取得する。
OTAアップデートの実行を処理する。
OTAアップデートの終了時に呼び出す関数を登録する。
OTAアップデートのエラー発生時に実行する関数を登録する。
OTAアップデートでの更新中に実行する関数を登録する。
OTAアップデートの開始時に呼び出す関数を登録する。
OTAアップデートで利用するホスト名を設定する。
OTAアップデートで利用するパスワードを設定する。
OTAアップデートで利用するパスワードをmd5ハッシュ形式で設定する。
OTAアップデートで利用するポートを設定する。
Bluetoothシリアルポートから読み取り可能なバイト数(文字数)を取得する。
Bluetoothシリアルデバイスを開始する。
Bluetoothシリアルポートから受信したデータを読む。
Bluetoothシリアルポートにバイナリデータを送信する。
EEPROMの利用開始。
EEPROMの利用開始。
EEPROM用のバッファにデータ(文字列)を書き込む。
EEPROMの利用開始。
EEPROMClassクラスのコンストラクタ。
EEPROM用のバッファからデータを読み出す。
設定したサイズを返却する。
EEPROM用のバッファにデータを書き込む。
mDNS(マルチキャストDNS) にホスト名を登録する。
ファイルパスの現在位置から読み出せるコンテンツのバイト数を返却する。
ファイルパスをクローズする。
ファイルパスの最終更新時刻を取得する。
ファイルクラスの変数がディレクトリを示しているか確認する。
ファイルパスのファイル名を取得する。
ファイルクラスの変数がが示すディレクトリ内のファイルを返却する。
ファイルクラスの変数が有効か確認する。
ファイルパスのファイルパス名(フルパス)を取得する。
ファイルパスの現在位置からコンテンツを読み出す。
ファイルパスのサイズを取得する。
ファイルパスの現在位置にコンテンツを書き込む。
ディレクトリを作成する。
ファイルパスをオープンする。
ファイルパスを削除する。
ファイルパス名を変更する。
ディレクトリを削除する。
アクセスするURLを登録する。
TCPコネクションを切断し、HTTP通信を終了する。
HTTPClient::begin()で登録したURLに、GETリクエストを送信する。
HTTPClient::begin()で登録したURLに、PATCHリクエストを送信する。
HTTPClient::begin()で登録したURLに、POSTリクエストを送信する。
HTTPClient::begin()で登録したURLに、PUTリクエストを送信する。
BASIC認証で利用する認証情報を設定する。
HTTPコネクションを再利用するよう指示する。
HTTPリクエストで取得したレスポンスメッセージのボディ部の長さを返却する。
HTTPリクエストで取得したレスポンスメッセージのボディ部を返却する。
HTTPコネクションのデータストリームへのポインタを返却する。
HTTPコネクションが接続されているかどうかを調べる。
HTTPエラーコードを文字列に変換する。
メッセージボディをストリームに書き出す。
NVS(Non-volatile storage)の利用を開始する。
NVS(Non-volatile storage)から、現在利用中のネームスペース内の全てのキー・バリューを削除する。
NVS(Non-volatile storage)の利用を終了する。
NVS(Non-volatile storage)から、現在利用中のネームスペース内の指定したキーに対応する値を取得する。
NVS(Non-volatile storage)に、現在利用中のネームスペース内の指定したキーに対応するバリューを書き込む。
NVS(Non-volatile storage)から、現在利用中のネームスペース内の指定したキー・バリューを削除する。
SPIFFSの利用を開始する。
定期実行する関数を登録する。
定期実行する関数を登録する。
attach()/attach_ms()/once()/once_ms()で登録した関数を削除する。
一度だけ実行する関数を登録する。
一度だけ実行する関数を登録する。
スケッチの更新を開始する。
スケッチの更新を終了する。
エラーが発生しているか確認する。
エラー情報を表示する。
スケッチを書き込む。
リクエストパラメータの値を返却する。
リクエストパラメータ名称を返却する。
リクエストパラメータ数を返却する。
Webサーバを開始する。
登録した情報に従ってクライアントからのリクエストを処理する。
メソッドを返却する。
指定したURIにアクセスがあった時に呼び出す関数を登録する。
登録していないURIにアクセスがあった時に呼び出す関数を登録する。
クライアントにレスポンスを送信する。
HTTPヘッダを追加する。
現在の状態を取得する。
リクエストURIを返却する。
WebServerクラスのコンストラクタ。
ストリームで利用可能なバイト数を取得する。
ホストとの接続状態を返却する。
指定したホストのポートにTCP接続する。
ASCIIテキストとして可読文字を送信する。
ASCIIテキストとして可読文字を送信する。
受信したデータを1バイト読む。
ホストとのTCP接続を切断する。
bool型変換演算子
WiFiの動作モードを設定する。
アクセスポイントを追加する。
addAP()で追加したアクセスポイントに接続する。
指定したネットワークの暗号化方式を取得する。
指定したネットワークのRSSIを取得する。
WiFiScan.scanNetworks()を非同期モードで実行した後、実行結果を取得する。
WiFiネットワークをスキャンし、利用可能なネットワーク(アクセスポイント)を取得する。
指定したネットワークのSSIDを取得する。
WiFiServerクラスのコンストラクタ。
WiFiクライアントからの接続を取得する。
WiFiサーバを開始する。
WiFiサーバを終了する。
bool型変換演算子
WiFiのアクセスポイントに接続する。
WiFiネットワークの設定を行う。
WiFiネットワークから切断する。
現在割り当てられているDNSサーバのIPアドレスを返却する。
現在割り当てられているゲートウェイのIPアドレスを返却する。
現在割り当てられているIPアドレスを返却する。
現在割り当てられているMACアドレスを返却する。
現在のWiFiの接続状態を返却する。
現在割り当てられているサブネットマスクを返却する。
WiFi接続が完了(成功か失敗する)するまで待つ。待ち時間は最大10秒。
アクセス先のホストのルート証明書を設定する。
指定したホストのポートにTCP接続する。
サーバとの接続状態を返却する。
ストリームで利用可能なバイト数を取得する。
ストリームからデータを読み込む。
ホストとのTCP接続を切断する。
HTTPS接続する際、証明書による検証を行わない。