06．ボリューム値の復元対応

Bluetoothオーディオレシーバーの電源を入れなおし、Bluetooth機能が搭載されているデバイス（スマートフォンやパソコン）からBluethoothの再接続をした際に、前回のボリューム値が復元されるようにします。

設定の保存、読込は、「Non-Volatile Storage (NVS)」機能を使用します。

前提

「05．絶対音量対応」を実施していない場合は、実施します。

ボリューム値の保存、読込の関数の宣言と定義

ボリューム値の保存、読込の関数の宣言のファイルを用意します。
ファイル名を「config.h」とします。
「bluetooth_audio_receiver」ディレクトリに配置します。

ファイル「config.h」の内容は以下のようにします。
#ifndef __CONFIG_H__ #define __CONFIG_H__ void config_init(); uint8_t config_get_volume(); void config_set_volume(uint8_t volume); #endif /* __CONFIG_H__ */

ボリューム値の保存、読込のための関数の宣言のファイルを用意します。
ファイル名を「config.c」とします。
「bluetooth_audio_receiver」ディレクトリに配置します。

ファイル「config.c」の内容は以下のようにします。
#include "nvs_flash.h" #define VOLUME_DEFAULT (50 * 0x7f / 100) void config_init() { // Initialize NVS esp_err_t err = nvs_flash_init(); if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) { // NVS partition was truncated and needs to be erased // Retry nvs_flash_init ESP_ERROR_CHECK(nvs_flash_erase()); err = nvs_flash_init(); } ESP_ERROR_CHECK( err ); } uint8_t config_get_volume() { printf("config_get_volume\n"); uint8_t volume = VOLUME_DEFAULT; // Open printf("Opening Non-Volatile Storage (NVS) handle... "); nvs_handle_t my_handle; esp_err_t err = nvs_open("storage", NVS_READONLY, &my_handle); if (err != ESP_OK) { printf("Error (%s) opening NVS handle!\n", esp_err_to_name(err)); } else { printf("Done\n"); // Read printf("Reading restart counter from NVS ... "); err = nvs_get_u8(my_handle, "volume", &volume); switch (err) { case ESP_OK: printf("Done\n"); printf("volume = %d\n", volume * 100 / 0x7f); break; case ESP_ERR_NVS_NOT_FOUND: printf("volume is not initialized yet!\n"); break; default : printf("Error (%s) reading!\n", esp_err_to_name(err)); } // Close nvs_close(my_handle); } return volume; } void config_set_volume(uint8_t volume) { printf("config_set_volume\n"); // Open printf("Opening Non-Volatile Storage (NVS) handle... "); nvs_handle_t my_handle; esp_err_t err = nvs_open("storage", NVS_READWRITE, &my_handle); if (err != ESP_OK) { printf("Error (%s) opening NVS handle!\n", esp_err_to_name(err)); } else { printf("Done\n"); // Write err = nvs_set_u8(my_handle, "volume", volume); printf((err != ESP_OK) ? "Failed!\n" : "Done\n"); // Commit written value. // After setting any values, nvs_commit() must be called to ensure changes are written // to flash storage. Implementations may write to storage at other times, // but this is not guaranteed. printf("Committing updates in NVS ... "); err = nvs_commit(my_handle); printf((err != ESP_OK) ? "Failed!\n" : "Done\n"); printf("volume = %d\n", volume * 100 / 0x7f); // Close nvs_close(my_handle); } }

ボリューム値の保存、読込の関数の呼び出し

「bt_app_av.c」内の、「s_volume」に関する処理を、すべて、「config_get_volume 関数」「config_set_volume 関数」の処理に置き換えます。

「bt_app_av.c」ファイル
（・・・略・・・） static TaskHandle_t s_vcs_task_hdl = NULL; /* handle for volume change simulation task */ //static uint8_t s_volume = 0; /* local volume value */ /* ボリューム値のNVSへの保存、NVSからの読込 */ static bool s_volume_notify; /* notify volume change or not */ （・・・略・・・） static void volume_set_by_controller(uint8_t volume) { ESP_LOGI(BT_RC_TG_TAG, "Volume is set by remote controller to: %"PRIu32"%%", (uint32_t)volume * 100 / 0x7f); /* set the volume in protection of lock */ _lock_acquire(&s_volume_lock); //s_volume = volume; config_set_volume( volume ); /* ボリューム値のNVSへの保存 */ _lock_release(&s_volume_lock); bt_app_set_volume(volume); /* ソフトウェアボリュームコントロール */ } static void volume_set_by_local_host(uint8_t volume) { ESP_LOGI(BT_RC_TG_TAG, "Volume is set locally to: %"PRIu32"%%", (uint32_t)volume * 100 / 0x7f); /* set the volume in protection of lock */ _lock_acquire(&s_volume_lock); //s_volume = volume; config_set_volume( volume ); /* ボリューム値のNVSへの保存 */ _lock_release(&s_volume_lock); /* send notification response to remote AVRCP controller */ if (s_volume_notify) { esp_avrc_rn_param_t rn_param; //rn_param.volume = s_volume; rn_param.volume = volume; /* s_volumeの廃止対応 */ esp_avrc_tg_send_rn_rsp(ESP_AVRC_RN_VOLUME_CHANGE, ESP_AVRC_RN_RSP_CHANGED, &rn_param); s_volume_notify = false; } } static void volume_change_simulation(void *arg) { ESP_LOGI(BT_RC_TG_TAG, "start volume change simulation"); for (;;) { /* volume up locally every 10 seconds */ vTaskDelay(10000 / portTICK_PERIOD_MS); //uint8_t volume = (s_volume + 5) & 0x7f; uint8_t volume = (config_get_volume() + 5) & 0x7f; /* ボリューム値のNVSからの読込 */ volume_set_by_local_host(volume); } } （・・・略・・・） static void bt_av_hdl_avrc_tg_evt(uint16_t event, void *p_param) { （・・・略・・・） switch (event) { （・・・略・・・） case ESP_AVRC_TG_REGISTER_NOTIFICATION_EVT: { ESP_LOGI(BT_RC_TG_TAG, "AVRC register event notification: %d, param: 0x%"PRIx32, rc->reg_ntf.event_id, rc->reg_ntf.event_parameter); if (rc->reg_ntf.event_id == ESP_AVRC_RN_VOLUME_CHANGE) { s_volume_notify = true; esp_avrc_rn_param_t rn_param; //rn_param.volume = s_volume; rn_param.volume = config_get_volume(); /* ボリューム値のNVSからの読込 */ bt_app_set_volume(rn_param.volume); /* ソフトウェアボリュームコントロール */ esp_avrc_tg_send_rn_rsp(ESP_AVRC_RN_VOLUME_CHANGE, ESP_AVRC_RN_RSP_INTERIM, &rn_param); } break; } （・・・略・・・）

「bt_app_av.c」ファイルのヘッダー部に、「#include "config.h"」を追加します。
（・・・略・・・） #include "sys/lock.h" #include "bt_app_volume_control.h" /* ソフトウェアボリュームコントロール */ #include "config.h" /* 設定の保存、読込 */ /* AVRCP used transaction labels */ （・・・略・・・）

config_init 関数の呼び出し

設定の保存、読込は、「Non-Volatile Storage (NVS)」機能を使用します。「Non-Volatile Storage (NVS)」機能を使用するには、初期化処理が必要です。
「Non-Volatile Storage (NVS)」の初期化処理を行う config_init 関数の呼び出しを、「main.c」ファイルの「app_main 関数」に、追加します。
（もともとある、「Non-Volatile Storage (NVS)」の初期化処理は、コメントアウトします）
（・・・略・・・） void app_main(void) { /* initialize NVS — it is used to store PHY calibration data */ /*esp_err_t err = nvs_flash_init(); if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) { ESP_ERROR_CHECK(nvs_flash_erase()); err = nvs_flash_init(); } ESP_ERROR_CHECK(err);*/ config_init(); /* 設定の保存、読込の初期化処理（NVSの初期化） */ esp_err_t err; /* 追加 */ /* * This example only uses the functions of Classical Bluetooth. * So release the controller memory for Bluetooth Low Energy. */ ESP_ERROR_CHECK(esp_bt_controller_mem_release(ESP_BT_MODE_BLE)); （・・・略・・・）

「main.c」ファイルのヘッダー部に、「#include "config.h"」を追加します。
（・・・略・・・） #include "esp_avrc_api.h" #include "config.h" /* 設定の保存、読込 */ /* device name */ #define LOCAL_DEVICE_NAME "ESP_SPEAKER" （・・・略・・・）

「CMakeLists.txt」ファイルの編集

ボリューム値に応じたオーディオデータに変更するための関数の定義のファイルを、ビルド対象に追加します。

「CMakeLists.txt」ファイルに、「config.c」を追加します。
idf_component_register(SRCS "bt_app_av.c" "bt_app_core.c" "bt_app_volume_control.c" "config.c" "main.c" INCLUDE_DIRS ".")

ビルド

以下のコマンドを実行し、プロジェクトのプログラムをビルドします。

idf.py build

完了するまで、しばらく待ちます。

フラッシュ

ビルド結果を、マイコンに書き込むフラッシュのコマンドは以下の書式です。

idf.py -p シリアル通信デバイス名 flash

シリアル通信デバイス名が「/dev/ttyUSB0」の場合は、以下のコマンドを実行します。

idf.py -p /dev/ttyUSB0 flash

完了するまで、しばらく待ちます。

動作確認

フラッシュが完了すると、マイコンに書き込まれたプログラムが起動します。

Bluetooth機能が搭載されているデバイス（スマートフォンやパソコン）から、作成した「Bluetooth Audio Receiver」にBluetooth接続します。
作成した「Bluetooth Audio Receiver」のデバイス名は「ESP_SPEAKER」です。

作成した「Bluetooth Audio Receiver」のイヤホンジャックに接続したイヤホンやスピーカーから、接続元のデバイスで再生したオーディオを聴くことができます。

Bluetoothオーディオレシーバーの電源を入れなおし、Bluetooth機能が搭載されているデバイス（スマートフォンやパソコン）からBluethoothの再接続をした際に、前回のボリューム値が復元されます。

関連ページ

前項目：05．絶対音量対応