# vs1003

**Repository Path**: RT-Thread-Mirror/vs1003

## Basic Information

- **Project Name**: vs1003
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-03
- **Last Updated**: 2023-10-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README





# vs1003

**版本：v1.0.0**

2023.09.17：初始版本

## 1、介绍

vs1003 驱动

### 1.1 依赖

- vs1003 是 SPI 通讯，需要 RT_USING_PIN，RT_USING_SPI 或 BSP_USING_SPI，已自动关联

- 同时需要在 board.h 打开具体使用的 spi 外设，如下

  ```c
  /** if you want to use spi bus you can use the following instructions.
   *
   * STEP 1, open spi driver framework support in the RT-Thread Settings file
   *
   * STEP 2, define macro related to the spi bus
   *                 such as     #define BSP_USING_SPI1
   *
   * STEP 3, copy your spi init function from stm32xxxx_hal_msp.c generated by stm32cubemx to the end of board.c file
   *                 such as     void HAL_SPI_MspInit(SPI_HandleTypeDef* hspi)
   *
   * STEP 4, modify your stm32xxxx_hal_config.h file to support spi peripherals. define macro related to the peripherals
   *                 such as     #define HAL_SPI_MODULE_ENABLED
   */
  
  /*#define BSP_USING_SPI1*/
  #define BSP_USING_SPI2
  /*#define BSP_USING_SPI3*/
  ```

  

## 2、示例使用

### 2.1 基础配置

对 vs1003 的控制脚和时钟进行配置。

根据驱动的不同，选择 spi 的不同函数 rt_hw_spi_device_attach

```C
#define SPI_DEVICE_ATTACH_PIN_NUM    1
#define SPI_DEVICE_ATTACH_GPIO_TYPE  2

#define SPI_DEVICE_ATTACH_MODE       SPI_DEVICE_ATTACH_PIN_NUM 

typedef struct
{
    char * name;
    char * spi_device_name;

#if (SPI_DEVICE_ATTACH_MODE == SPI_DEVICE_ATTACH_GPIO_TYPE)
    GPIO_TypeDef* GPIO_CS_Port;
    unsigned short GPIO_CS_Pin;
#elif (SPI_DEVICE_ATTACH_MODE == SPI_DEVICE_ATTACH_PIN_NUM)
    rt_base_t pin_spi_CS;
#endif

    rt_base_t pin_DREQ;
    rt_base_t pin_XCS;
    rt_base_t pin_XDCS;
    rt_base_t pin_XRESET;

    void (* pin_clk_enable) (void);

}VS1003_CONFIG;
```
在 VS1003_init 函数中

```c
#if (SPI_DEVICE_ATTACH_MODE == SPI_DEVICE_ATTACH_GPIO_TYPE)
    res = rt_hw_spi_device_attach(VS1003_dev->config->spi_device_name, 
            VS1003_dev->config->name,
            VS1003_dev->config->GPIO_CS_Port,
            VS1003_dev->config->GPIO_CS_Pin);
#elif (SPI_DEVICE_ATTACH_MODE == SPI_DEVICE_ATTACH_PIN_NUM)
    res = rt_hw_spi_device_attach(VS1003_dev->config->spi_device_name, 
            VS1003_dev->config->name,
            VS1003_dev->config->pin_spi_CS);
#endif
```



需要注意的是 spi 片选脚，由于 VS1003 的命令脚和数据脚是分开的，所有这个脚位需要设置为空脚 

```c
#define VS1003_SPI_DEVICE_NAME    "spi2"
#define VS1003_DEVICE_NAME        "spi20"

extern unsigned char mp3[38400];

VS1003_DEVICE VS1003_dev;

void VS1003_pin_clk_enable(void);

VS1003_CONFIG VS1003_config = 
{
        .name = VS1003_DEVICE_NAME,
        .spi_device_name = VS1003_SPI_DEVICE_NAME,

        /* 这个片选脚是给 spi 设备的，
       由于 VS1003 的命令脚和数据脚是分开的，
       所有这个脚位需要设置为空脚  */
#if (SPI_DEVICE_ATTACH_MODE == SPI_DEVICE_ATTACH_GPIO_TYPE)
        .GPIO_CS_Port = GPIOD,
        .GPIO_CS_Pin  = GPIO_PIN_13,
#elif (SPI_DEVICE_ATTACH_MODE == SPI_DEVICE_ATTACH_PIN_NUM)
        .pin_spi_CS = 61,    // PD13
#endif
        

        .pin_DREQ   = 54,    // PD6
        .pin_XCS    = 28,    // PB12
        .pin_XDCS   = 55,    // PD7
        .pin_XRESET = 59,    // PD11

        .pin_clk_enable = VS1003_pin_clk_enable,
};

void VS1003_pin_clk_enable(void)
{
    __HAL_RCC_GPIOB_CLK_ENABLE();
    __HAL_RCC_GPIOD_CLK_ENABLE();
}
```

### 2.2 初始化

将 VS1003_config 配置给 vs1003 设备

```
int vs1003_example_init(void)
{
    if(RT_EOK != VS1003_init(&VS1003_dev, &VS1003_config))
    {
        rt_kprintf("VS1003_init VS1003 err\r\n");
        return -RT_ERROR;
    }

    return RT_EOK;
}

INIT_APP_EXPORT(vs1003_example_init);
```

### 2.3 测试正弦音

在控制台中输入命令 "vs1003_example_sine"，如果发出 “嘀嘟” 的声音，说明 vs1003 控制没有问题，spi 通讯正常。

```
void vs1003_example_sine(void)
{
    if(RT_EOK != VS1003_Sine_Test(&VS1003_dev, 0x24, 0x74))
    {
        rt_kprintf("VS1003_Sine_Test VS1003 err\r\n");
    }
}
MSH_CMD_EXPORT(vs1003_example_sine, 'vs1003 example sine');
```

### 2.4 测试播放

在控制台中输入命令 "vs1003_example_play"，如果发出八音盒音乐的声音，说明 vs1003 数据播放没有问题，spi 通讯正常。

mp3[38400] 是一个八音盒音乐，比特率为 48kbps，音效不好，只要发出声音就说明 vs1003 已经正常工作。

```
void vs1003_example_play(void)
{
    int size = 38400;
    int pos = 0;

    VS1003_Set_Vol(&VS1003_dev, 0X2020);

    while (1)
    {
        if(0 != VS1003_DREQ_state(VS1003_dev.config->pin_DREQ))
        {
            VS1003_Send_data(&VS1003_dev, &mp3[pos], 32);
            pos += 32;
            if(size < pos)
            {
                VS1003_Restart_Play(&VS1003_dev);
                break;
            }
        }
    }
}
MSH_CMD_EXPORT(vs1003_example_play, 'vs1003 example play');
```