技術仕様書: Bluetoothアンプコントローラーファームウェア
|
ドキュメントバージョン |
1.0 |
|
作成日 |
2025年9月15日 |
|
対象ファームウェア |
configAmplifier.ino |
|
作成者 |
Gemini (AIアシスタント) |
1. 概要
本ドキュメントは、ESP32マイクロコントローラとDFRobot社製MAX98357A搭載Bluetoothアンプモジュールを制御するためのファームウェア「configAmplifier.ino」の技術的な仕様を定義するものです。
本ファームウェアは、対象ハードウェアをBluetoothスピーカーとして機能させます。スマートフォンやPCなどのBluetooth対応デバイスから音声データを受信して再生するだけでなく、シリアル通信を介して音量、オーディオフィルター、再生制御などを動的に設定・操作する機能を提供します。
2. 動作環境
2.1. 対象ハードウェア
本ファームウェアの動作には、以下のハードウェアが必要です。
|
仕様/モデル |
備考 |
|
|
マイクロコントローラ |
ESP32 開発ボード |
|
|
アンプモジュール |
DFRobot MAX98357A搭載 Bluetoothアンプモジュール |
I2Sインターフェースを持つもの |
|
スピーカー |
- |
アンプモジュールの出力に適したもの |
|
電源 |
3.3V / 5V |
システム全体に安定して供給できるもの |
2.2. ソフトウェア要件
|
項目 |
バージョン/設定 |
|
開発環境 |
|
|
ボード設定 |
ESP32 Dev Module (または互換ボード) |
|
必須ライブラリ |
DFRobot_MAX98357A (バージョン 1.0.1以降) |
3. ハードウェア接続仕様
3.1. ピン配置
ESP32とアンプモジュール間は、I2S (Inter-IC Sound) プロトコルで通信します。以下のピン接続を前提としています。
|
ESP32 GPIO |
アンプモジュール ピン |
信号名 |
機能 |
|
GPIO 25 |
DIN |
Data In |
オーディオデータ信号 |
|
GPIO 26 |
BCLK (BLK) |
Bit Clock |
ビットクロック信号 |
|
GPIO 27 |
LRC (LRCLK) |
Left/Right Clock |
L/Rチャンネル選択クロック |
|
3V3 or 5V |
VIN / VCC |
Power |
電源供給 |
|
GND |
GND |
Ground |
接地 |
※注意: 電源(VIN/VCC)とGNDの接続は必須です。
4. 機能仕様
4.1. 起動シーケンス (初期化処理)
電源投入後、setup()関数により以下の初期化処理が実行されます。
- デバイス名: bluetoothAmplifier として起動します。
- I2Sインターフェース初期化: 上記「3.1. ピン配置」で定義されたGPIOピンでI2S通信を開始します。
- 音量設定: 初期音量を 5 に設定します (範囲: 0-9、5が原音)。
- フィルター設定: 初期状態で500Hzのハイパスフィルターを有効にします。
- リモートデバイスアドレス取得: 起動後、Bluetoothでペアリング・接続されたデバイスのアドレス取得を試み、成功した場合シリアルモニタに表示します。
- 自動再生コマンド送信: 初期化の最後に、接続されたデバイスに対して再生開始コマンド(AVRCP PLAY)を送信します。
4.2. Bluetooth機能
|
機能 |
仕様 |
|
オーディオ受信 |
A2DP (Advanced Audio Distribution Profile) に対応し、高品質なステレオ音声を受信します。 |
|
リモートコントロール |
AVRCP (Audio/Video Remote Control Profile) に対応し、再生/停止/曲送り/曲戻しなどのコマンドを送信できます。 |
|
ペアリング |
4.3. シリアルコマンドインターフェース
ファームウェア実行中、シリアルモニタからコマンドを送信することで、アンプの各種設定をリアルタイムに変更できます。
- コマンド形式: コマンド-値
- 値が不要な場合は コマンド- の形式で送信します。
- コマンド送信後、Enterキーを押すか「送信」ボタンをクリックします。
- コマンド一覧:
|
コマンド |
パラメータ (値) |
機能説明 |
例 |
|
vol |
0～9 の整数 |
音量を設定します。5が原音量で、値が小さいほど音が小さくなります。 |
vol-8 |
|
hp |
2～20000 の整数 |
ハイパスフィルターを設定します。指定した周波数以下の音をカットします。 |
hp-1000 |
|
lp |
2～20000 の整数 |
ローパスフィルターを設定します。指定した周波数以上の音をカットします。 |
lp-12000 |
|
closeFilter |
(なし) |
設定されている全てのオーディオフィルターを無効化します。 |
closeFilter- |
|
start |
(なし) |
再生を開始します (AVRCP PLAY)。 |
start- |
|
stop |
(なし) |
再生を停止します (AVRCP STOP)。 |
stop- |
|
next |
(なし) |
次のトラックへ進みます (AVRCP FORWARD)。 |
next- |
|
previous |
(なし) |
前のトラックへ戻ります (AVRCP BACKWARD)。 |
previous- |
|
addr |
(なし) |
addr- |
※ 不明なコマンドが入力された場合、シリアルモニタに上記コマンド一覧のヘルプメッセージが表示されます。
5. ソースコード情報
|
項目 |
内容 |
|
ファイル名 |
configAmplifier.ino |
|
Copyright (c) 2010 DFRobot Co.Ltd (http://www.dfrobot.com) |
|
|
ライセンス |
The MIT License (MIT) |
/*!
* @file configAmplifier.ino
* @details After reading the bluetoothAmplifier.ino sample, you may succeed in playing music.
* @n This demo allows you to simply configure the player: set volume, set filter, get the address of the remote Bluetooth device
* @n You can configure it through the setup function, and can also adjust the config through the serial command when the program is running as per the code comment in the loop function.
* @note The serial operation can be directly changed to other operations such as button or knob in practice so as to realize a real Bluetooth speaker.
* @license The MIT License (MIT)
* @author [qsjhyy](yihuan.huang@dfrobot.com)
* @version V1.0
* @date 2022-01-27
*/
#include <DFRobot_MAX98357A.h>
DFRobot_MAX98357A amplifier; // instantiate an object to control the amplifier
/**************************************************************
Setup And Loop
**************************************************************/
x
void setup(void)
{
Serial.begin(115200);
/**
* @brief Init function
* @param bclk - I2S communication pin number, serial clock (SCK), aka bit clock (BCK)
* @param lrclk - I2S communication pin number, word select (WS), i.e. command (channel) select, used to switch between left and right channel data
* @param din - I2S communication pin number, serial data signal (SD), used to transmit audio data in two's complement format
* @return true on success, false on error
*/
while( !amplifier.begin(/*btName=*/"bluetoothAmplifier", /*bclk=*/26, /*lrclk=*/27, /*din=*/25) ){
while( !amplifier.begin(/*btName=*/"bluetoothAmplifier", /*bclk=*/GPIO_NUM_25, /*lrclk=*/GPIO_NUM_26, /*din=*/GPIO_NUM_27) ){
Serial.println("Initialize failed !");
delay(3000);
}
Serial.println("Initialize succeed!");
/**
* @fn reverseLeftRightChannels
* @brief Reverse left and right channels, When you find that the left
* @n and right channels play opposite, you can call this interface to adjust
*/
// amplifier.reverseLeftRightChannels();
/**
* @brief Set volume
* @param vol - Set volume, the range can be set to 0-9
* @note 5 for the original volume of audio data, no increase or decrease
*/
amplifier.setVolume(5);
/**
* @brief Close the audio filter
* @note The high-pass filter and the low-pass filter will be closed at the same time because they work simultaneously,
* @n When you set the range outstripping the value people's ears can distinguish, it is considered to close the corresponding filter;
* @n The initial values of the filters are bq_type_highpass(2) and bq_type_lowpass(20000),
* @n The filter is considered to be off at this time.
*/
amplifier.closeFilter();
/**
* @brief Open audio filter
* @param type - bq_type_highpass: open high-pass filtering; bq_type_lowpass: open low-pass filtering
* @param fc - Threshold of filtering, range: 2-20000
* @note For example, setting high-pass filter mode and the threshold of 500 indicates to filter out the audio signal below 500; high-pass filter and low-pass filter will work simultaneously.
*/
amplifier.openFilter(bq_type_highpass, 500);
/**
* @note The address will be obtained after the module is paired with the remote Bluetooth device and successfully communicates with it based on the Bluetooth AVRCP protocol.
* @n Return None when the module does not connect to the remote device or failed to communicate with it based on the Bluetooth AVRCP protocol.
*/
uint8_t * addr = amplifier.getRemoteAddress();
/**
* Print the obtained address of the remote Bluetooth device
* Note: if the remote Bluetooth address is not obtained, it keeps waiting.
* The function implementation follows this demo, you can change it as per your need.
*/
printRemoteAddress(addr);
/**
* @param[in] tl : transaction label, 0 to 15, consecutive commands should use different values.
* @param[in] key_code : passthrough command code, e.g.
* @n ESP_AVRC_PT_CMD_PLAY : start playback;
* @n ESP_AVRC_PT_CMD_STOP : stop playback;
* @n ESP_AVRC_PT_CMD_BACKWARD : play the previous one;
* @n ESP_AVRC_PT_CMD_FORWARD : play the next one; etc.
* @param[in] key_state : passthrough command key state, ESP_AVRC_PT_CMD_STATE_PRESSED or ESP_AVRC_PT_CMD_STATE_RELEASED
* @note This function may not be so practical, but you can try it if you are interested. For the details refer to:
*/
esp_avrc_ct_send_passthrough_cmd(/*tl=*/0, /*tl=key_code*/ESP_AVRC_PT_CMD_PLAY, /*tl=key_state*/ESP_AVRC_PT_CMD_STATE_PRESSED);
}
}
void loop()
{
/**
* @brief The parsing and implementation of the serial command is to call the config function above by the serial command when the program is running
* @note The amplifier can be configured by entering the corresponding command in the serial port, format: cmd-value (command - set value, some commands that don't require assignment can be omitted)
* @n Currently available commands:
* @n Set and open high-pass filter: e.g. hp-500
* @n Set and open low-pass filter: e.g. lp-15000
* @n Close filter: e.g. closeFilter-
* @n Set volume: e.g. vol-5
* @n Start playback: e.g. start-
* @n Stop playback: e.g. stop-
* @n Play last track: e.g. previous-
* @n Play next track: e.g. next-
* @n Other commands will print this description
* @n For the detailed meaning of the commands, please refer to the comments of the corresponding functions.
*/
parseSerialCommand();
delay(500);
}
/**************************************************************
Print the obtained remote Bluetooth address
**************************************************************/
void printRemoteAddress(uint8_t * _addr)
{
while(NULL == _addr){ // When obtaining remote Bluetooth address failed, it will wait until it succeeds.
delay(5000);
}
for(uint8_t i=0; i<5; i++){
Serial.print(*_addr, HEX);
Serial.print("-");
_addr++;
}
Serial.println(*_addr, HEX);
Serial.println();
}
/**************************************************************
The parsing and implementation of the serial command
**************************************************************/
void parseSerialCommand(void)
{
String cmd; // Save the command type read in the serial port
/**
* Command format: cmd-value
* cmd: command type
* For example: (1) set high-pass filter, filter the audio data below 500: hp-500
* (2) close filter: closeFilter-
*/
if(Serial.available()){ // Detect whether there is an available serial command
cmd = Serial.readStringUntil('-'); // Read the specified termination character string, used to cut and identify the serial command. The same type won't repeat later.
if(cmd.equals("hp")){ // Determine if it's the command type for setting high-pass filter
Serial.println("Setting a High-Pass filter...\n");
/**
* @brief Open audio filter
* @param type - bq_type_highpass: open high-pass filtering; bq_type_lowpass: open low-pass filtering
* @param fc - Threshold of filtering, range: 2-20000
* @note For example, setting high-pass filter mode and the threshold of 500 indicates to filter out the audio signal below 500; high-pass filter and low-pass filter can work simultaneously.
*/
}else if(cmd.equals("lp")){ // Determine if it's the command type for setting low-pass filter
Serial.println("Setting a Low-Pass filter...\n");
}else if(cmd.equals("closeFilter")){ // Determine if it's the command type for closing filter
Serial.println("Closing filter...\n");
/**
* @brief Close the audio filter
*/
amplifier.closeFilter();
}else if(cmd.equals("vol")){ // Determine if it's the command type for setting volume
Serial.println("Setting volume...\n");
/**
* @brief Set volume
* @param vol - Set volume, the range can be set to 0-9
* @note 5 for the original volume of audio data, no increase or decrease
*/
}else if(cmd.equals("addr")){ // Determine if it's the command type for obtaining remote Bluetooth address
/**
* @note The address will be obtained after the module is paired with the remote Bluetooth device and successfully communicates with it based on the Bluetooth AVRCP protocol.
* @n Return None when the module does not connect to the remote device or failed to communicate with it based on the Bluetooth AVRCP protocol.
*/
uint8_t * addr = amplifier.getRemoteAddress();
/**
* Print the obtained address of the remote Bluetooth device
* Note: if the remote Bluetooth address is not obtained, it keeps waiting.
* The function implementation follows this demo, you can change it as per your need.
*/
printRemoteAddress(addr);
}else if(cmd.equals("start")){ // Determine if it's the command type for starting playback
Serial.println("starting amplifier...\n");
/**
* @param[in] tl : transaction label, 0 to 15, consecutive commands should use different values.
* @param[in] key_code : passthrough command code, e.g. ESP_AVRC_PT_CMD_PLAY, ESP_AVRC_PT_CMD_STOP, etc.
* @param[in] key_state : passthrough command key state, ESP_AVRC_PT_CMD_STATE_PRESSED or ESP_AVRC_PT_CMD_STATE_RELEASED
* @note This function may not be so practical, but you can try it if you are interested. For the details refer to:
*/
esp_avrc_ct_send_passthrough_cmd(0, ESP_AVRC_PT_CMD_PLAY, ESP_AVRC_PT_CMD_STATE_PRESSED);
}else if(cmd.equals("stop")){ // Determine if it's the command type for stopping playback
Serial.println("Stopping amplifier...\n");
// Same as the above.
esp_avrc_ct_send_passthrough_cmd(0, ESP_AVRC_PT_CMD_STOP, ESP_AVRC_PT_CMD_STATE_PRESSED);
}else if(cmd.equals("previous")){ // Determine if it's the command type for playing last track
Serial.println("Playing previous...\n");
// Same as the above.
esp_avrc_ct_send_passthrough_cmd(0, ESP_AVRC_PT_CMD_BACKWARD, ESP_AVRC_PT_CMD_STATE_PRESSED);
}else if(cmd.equals("next")){ // Determine if it's the command type for playing next track
Serial.println("Playing next...\n");
// Same as the above.
esp_avrc_ct_send_passthrough_cmd(0, ESP_AVRC_PT_CMD_FORWARD, ESP_AVRC_PT_CMD_STATE_PRESSED);
}else{ // Unknown command type
Serial.println("Help : \n \
Currently available commands (format: cmd-value):\n \
Set and open high-pass filter: e.g. hp-500\n \
Set and open low-pass filter: e.g. lp-15000\n \
Close filter: e.g. closeFilter-\n \
Set volume: e.g. vol-5.0\n \
Get the address of the remote Bluetooth device: e.g. addr-\n \
Start playback: e.g. start-\n \
Stop playback: e.g. stop-\n \
Play last track: e.g. previous-\n \
Play next track: e.g. next-\n \
For more details about commands, please refer to the code comments of this demo.\n"); //
}
while(Serial.read() >= 0); // Clear the remaining data in the serial port
}
}
以上が、本ファームウェアの技術仕様書となります。
