ES8374ドライバー

ES8374 Driver

ES8374コーデックチップ用のドライバ。

Driver for ES8374 codec chip.

APIリファレンス

API Reference

ヘッダーファイル

Header File

関数

Functions
esp_err_t es8374_codec_init(audio_hal_codec_config_t *cfg)

ES8374コーデックチップを初期化します。

Initialize ES8374 codec chip.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • cfg: ES8374の構成
    cfg: configuration of ES8374

esp_err_t es8374_codec_deinit(void)

ES8374コーデックチップを非初期化します。

Deinitialize ES8374 codec chip.

Return
  • ESP_OK
  • ESP_FAIL

esp_err_t es8374_config_fmt(es_module_t mode, es_i2s_fmt_t fmt)

ES8374I2Sフォーマットを構成します。

Configure ES8374 I2S format.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • mode: ADCまたはDAC、あるいはその両方を設定する
    mode: set ADC or DAC or both
  • fmt: ES8374I2Sフォーマット
    fmt: ES8374 I2S format

esp_err_t es8374_i2s_config_clock(es_i2s_clock_t cfg)

I2SクロックをMASTERモードで構成します。

Configure I2S clock in MSATER mode.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • cfg: ビットクロックとWSクロックを設定します
    cfg: set bits clock and WS clock

esp_err_t es8374_set_bits_per_sample(es_module_t mode, es_bits_length_t bit_per_sample)

ES8374データサンプルビットを設定します。

Configure ES8374 data sample bits.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • mode: ADCまたはDAC、あるいはその両方を設定する
    mode: set ADC or DAC or both
  • bit_per_sample: サンプルあたりのビット数
    bit_per_sample: bit number of per sample

esp_err_t es8374_start(es_module_t mode)

ES8374コーデックチップを起動します。

Start ES8374 codec chip.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • mode: ADCまたはDAC、あるいはその両方を設定する
    mode: set ADC or DAC or both

esp_err_t es8374_stop(es_module_t mode)

ES8374コーデックチップを停止します。

Stop ES8374 codec chip.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • mode: ADCまたはDAC、あるいはその両方を設定する
    mode: set ADC or DAC or both

esp_err_t es8374_codec_set_voice_volume(int volume)

音声音量を設定します。

Set voice volume.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • volume: 音量（0〜100）
    volume: voice volume (0~100)

esp_err_t es8374_codec_get_voice_volume(int *volume)

音声音量を取得します。

Get voice volume.

Return
  • ESP_OK
  • ESP_FAIL
Parameters
  • *volume: 音量（0〜100）
    *volume: voice volume (0~100)

esp_err_t es8374_set_voice_mute(bool enable)

ES8374DACをミュートまたはミュート解除します。 基本的に、この関数を使用して、出力をミュートまたはミュート解除できます。

Mute or unmute ES8374 DAC. Basically you can use this function to mute or unmute the output.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • enable: mute（1）またはunmute（0）
    enable: mute(1) or unmute(0)

esp_err_t es8374_get_voice_mute(void)

ES8374DACミュートステータスを取得します。

Get ES8374 DAC mute status.

Return
  • ESP_FAIL
  • ESP_OK

esp_err_t es8374_set_mic_gain(es_mic_gain_t gain)

ES8374マイクゲインを設定します。

Set ES8374 mic gain.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • gain: マイクゲインのdb
    gain: db of mic gain

esp_err_t es8374_config_adc_input(es_adc_input_t input)

ES8374ADC入力モードを設定します。

Set ES8374 ADC input mode.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • input: adc入力モード
    input: adc input mode

esp_err_t es8374_config_dac_output(es_dac_output_t output)

ES8374DAC出力モードを設定します。

Set ES8374 DAC output mode.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • output: dac出力モード
    output: dac output mode

esp_err_t es8374_write_reg(uint8_t reg_add, uint8_t data)

ES8374レジスタに書き込みます。

Write ES8374 register.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • reg_add: レジスタのアドレス
    reg_add: address of register
  • data: レジスタのデータ
    data: data of register

void es8374_read_all()

すべてのES8374レジスタを出力します。

Print all ES8374 registers.

Return
  • void

esp_err_t es8374_codec_config_i2s(audio_hal_codec_mode_t mode, audio_hal_codec_i2s_iface_t *iface)

ES8374コーデックモードとI2Sインターフェイスを設定します。

Configure ES8374 codec mode and I2S interface.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • mode: コーデックモード
    mode: codec mode
  • iface: I2S構成
    iface: I2S config

esp_err_t es8374_codec_ctrl_state(audio_hal_codec_mode_t mode, audio_hal_ctrl_t ctrl_state)

ES8374コーデックチップを制御します。

Control ES8374 codec chip.

Return
  • ESP_FAIL パラメータエラー
    ESP_FAIL Parameter error
  • ESP_OK 成功
    ESP_OK Success
Parameters
  • mode: コーデックモード
    mode: codec mode
  • ctrl_state: デコードの開始または停止、または進行状況のエンコード
    ctrl_state: start or stop decode or encode progress

void es8374_pa_power(bool enable)

ES8374PA電源を設定します。

Set ES8374 PA power.

Return
  • void
Parameters
  • enable: PA電源を有効にする場合はtrue、PA電源を無効にする場合はfalse
    enable: true for enable PA power, false for disable PA power

マクロ

Macros
ES8374_ADDR