Arduino core for ESP32 WiFi chip リファレンス

garretlab
Arduino core for ESP32 WiFi chip リファレンス

はじめに

このリファレンスは、Arduino core for ESP32 WiFi chipの関数やライブラリの使い方をまとめたものです。

全ての関数やメソッドを網羅しているわけではなく、スケッチ例などに出てくるものを中心に、選択したものです。

Arduino core for the ESP32 WiFi chipは、変更が多いのと、実際には動作させず、ソースを読んだ結果のものが多いので、最新版とは動作が異なったり、私の解釈が間違えている可能性も高いので、利用には注意してください。

現状は、スケッチ例で利用されているものを少しずつ記述しているだけなので、以下に記載のない関数やライブラリもたくさんあります。

Arduino本体のリファレンスの日本語訳はこちらです。

coresリファレンス

時刻
configTime() NTPサーバと時刻を同期させるとともに、ローカルのタイムゾーン(環境変数TZ)を設定する。
getLocalTime() ローカル時刻を取得する。
LED PWM
ledcSetup() LED PWMで利用するチャネルを設定する。
ledcAttachPin() LED PWMで利用するピンとチャネルを結びつける。
ledcDetachPin() LED PWMで利用するピンとチャネルの結びつきを解除する。
ledcWrite() LED PWMを利用して、指定したデューティ比でPWM出力する。
ledcWriteTone() LED PWMを利用して、指定した周波数をPWM出力する。
ledcWriteNote() LED PWMを利用して、指定した音階をPWM出力する。
ledcRead() LED PWMのチャネルに指定したデューティ比を取得する。
ledcReadFreq() LED PWMのチャネルに指定した周波数を取得する。
シグマデルタ
sigmaDeltaSetup() シグマデルタ変調で利用するチャネルを設定する。
sigmaDeltaAttkachPin() シグマデルタ変調で利用するピンとチャネルを結びつける。
sigmaDeltaDetachPin() シグマデルタ変調で利用するピンとチャネルを結びつきを解除する。
sigmaDeltaWrite() シグマデルタ変調を利用して、指定したデューティ比で出力する。
sigmaDeltaRead() シグマデルタ変調のチャネルに指定したデューティ比を取得する。
タイマー
timerBegin() タイマーの初期設定を行う。
timerAlarmEnable() タイマーを開始する。
timerEnd() タイマーを停止する。
timerAttachInterrupt() タイマー割り込みが発生したときに実行する関数を登録する。
timerAlarmWrite() タイマーの設定値(割り込みのタイミング)を設定する。
timerWrite() タイマーの値(現在値)を設定する。
タッチセンサ
touchRead() タッチセンサの値を読み取る。
touchAttachInterrupt() タッチセンサに触れたときに実行する関数を登録する。
ホールセンサ
hallRead() ホールセンサの値を読み取る。
割り込み
attachInterrupt() 指定したGPIOピンに対する割り込みハンドラを定義する。
EspClass
restart() ESP32を再起動します。
getEfuseMac() ESP32のMACアドレスを取得します。

ライブラリリファレンス

WiFiClass(WiFiGeneric)
mode() WiFiの動作モードを設定する。
WiFiClass(WiFiSTAClass)
config() WiFiネットワークの設定を行う。
begin() WiFiのアクセスポイントに接続する。
localIP() 現在割り当てられているIPアドレスを返却する。
macAddress() 現在割り当てられているMACアドレスを返却する。
subnetMask() 現在割り当てられているサブネットマスクを返却する。
gateweyIP() 現在割り当てられているゲートウェイIPアドレスを返却する。
dnsIP() 現在割り当てられているDNSサーバのIPアドレスを返却する。
status() 現在のWiFiの接続状態を返却する。
disconnect() WiFiネットワークから切断する。
waitForConnectResult() WiFi接続が完了(成功か失敗する)するまで待つ。
WiFiClass(WiFiScan)
scanNetworks() WiFiネットワークをスキャンし、利用可能なネットワーク(アクセスポイント)を取得する。
scanComplete() WiFiScan.scanNetworks()を非同期モードで実行した後、実行結果を取得する。
SSID() 現在接続しているネットワークのSSIDを取得する。
RSSI() 現在接続しているネットワークのRSSIを取得する。
encryptionType() 指定したネットワークの暗号化方式をを取得する。
WiFiMulti
addAP() アクセスポイントを追加する。
run() addAP()で追加したアクセスポイントに接続する。
WiFIClient
connect() 指定したホストのポートにTCP接続する。
connected() ホストとの接続状態を返却する。
stop() ホストとのTCP接続を切断する。
available() ストリームで利用可能なバイト数を取得する。
WiFIClientSecure
setCACert() アクセス先のホストのルート証明書を設定する。
connect() 指定したホストのポートにTCP接続する。
connected() ホストとの接続状態を返却する。
available() ストリームで利用可能なバイト数を取得する。
read() ストリームからデータを読み込む。
stop() ホストとのTCP接続を切断する。
WiFiServer
available WiFiクライアントからの接続を取得する。
HTTPClient
begin() アクセスするURLを登録する。
end() TCPコネクションを切断し、HTTP通信を終了する。
GET() begin()で登録したURLに、GETリクエストを送信する。
setAuthorization() BASIC認証で利用する認証情報を設定する。
setReukkse() HTTPコネクションを再利用するよう指示する。
getSize() HTTPリクエストで取得したレスポンスメッセージのボディ部の長さを返却する。
getString() HTTPリクエストで取得したレスポンスメッセージのボディ部を返却する。
getStreamPtr() HTTPコネクションのデータストリームへのポインタを返却する。
connected() HTTPコネクションが接続されているかどうかを調べる。
WebServer
WebServer() WebServerクラスのコンストラクタ。
send() クライアントにレスポンスを送信する。
method() メソッドを返却する。
uri() リクエストURIを返却する。
args() リクエストパラメータ数を返却する。
argName() リクエストパラメータ名称を返却する。
arg() リクエストパラメータ値を返却する。
on() 指定したURIにアクセスがあった時に呼び出す関数を登録する。
onNotFound() 登録していないURIにアクセスがあった時に呼び出す関数を登録する。
begin() Webサーバを開始する。
.handleClient() 登録した情報に従ってクライアントからのリクエストを処理する。
upload() リクエストボディ受信中の状態を取得する。
MDNSResponder
begin() mDNS(マルチキャストDNS) にホスト名を登録する。
BluetoothSerial
begin() Bluetoothデバイスのローカルネームを登録し、Bluetoothシリアルデバイスを開始する。
available() Bluetoothシリアルポートから読み取り可能なバイト数(文字数)を取得する。
read() Bluetoothシリアルポートから受信したデータを読む。
write() Bluetoothシリアルポートにバイナリデータを送信する。
Ticker
attach() 定期実行する関数を登録する。
attach_ms() 定期実行する関数を登録する。
once() 一度だけ実行する関数を登録する。
once_ms() 一度だけ実行する関数を登録する。
detach() attach()/attach_ms()/once()/once_ms()で登録した関数を削除する。
ArduinoOTAClass
begin() OTAアップデートサービスを開始する。
handle() OTAアップデートの実行を処理する。
setPort() OTAアップデートで利用するポートを設定する。
setHostname() OTAアップデートで利用するホスト名を設定する。
setPassword() OTAアップデートで利用するパスワードを設定する。
setPasswordHash() OTAアップデートで利用するパスワードをmd5ハッシュ形式で設定する。
getCommand() OTAアップデート時のコマンドを取得する。
onStart() OTAアップデートの開始時に呼び出す関数を登録する。
onEnd() OTAアップデートの終了時に呼び出す関数を登録する。
onProgress() OTAアップデートでの更新中に実行する関数を登録する。
onError() OTAアップデートのエラー発生時に実行する関数を登録する。
UpdateClass
begin() スケッチの更新を開始する。
end() スケッチの更新を終了する。
write() スケッチを書き込む。
hasError() エラーが発生しているか確認する。
Preferences
begin() NVS(Non-volatile storage)の利用を開始する。
end() NVS(Non-volatile storage)の利用を終了する。
clear() NVS(Non-volatile storage)から、現在利用中のネームスペース内の全てのキー・バリューを削除する。
remove() NVS(Non-volatile storage)から、現在利用中のネームスペース内の指定したキー・バリューを削除する。
putChar()
putUChar()
putShort()
putUShort()
putInt()
putUInt()
putLog()
putULong()
putLong64()
putULong64()
putFloat()
putDouble()
putBool()
putString()
NVS(Non-volatile storage)に、現在利用中のネームスペース内の指定したキーに対応する値を書き込む。。
getChar()
getUChar()
getShort()
getUShort()
getInt()
getUInt()
getLog()
getULong()
getLong64()
getULong64()
getFloat()
getDouble()
getBool()
getString()
NVS(Non-volatile storage)から、現在利用中のネームスペース内の指定したキーに対応する値を取得する。


メニューを表示するためにJavaScriptを有効にしてください。

inserted by FC2 system