docs/syn6658/driver__syn6658_8h_source.html

#ifndef DRIVER_SYN6658_H

#define DRIVER_SYN6658_H


#include <stdio.h>

#include <stdint.h>

#include <string.h>


#ifdef __cplusplus

extern "C"{

#endif


#ifndef SYN6658_BUSY_TIMEOUT

    #define SYN6658_BUSY_TIMEOUT        1000

#endif


#define SYN6658_SOUND_101        "sound101"

#define SYN6658_SOUND_102        "sound102"

#define SYN6658_SOUND_103        "sound103"

#define SYN6658_SOUND_104        "sound104"

#define SYN6658_SOUND_105        "sound105"

#define SYN6658_SOUND_106        "sound106"

#define SYN6658_SOUND_107        "sound107"

#define SYN6658_SOUND_108        "sound108"

#define SYN6658_SOUND_109        "sound109"

#define SYN6658_SOUND_110        "sound110"

#define SYN6658_SOUND_111        "sound111"

#define SYN6658_SOUND_112        "sound112"

#define SYN6658_SOUND_113        "sound113"

#define SYN6658_SOUND_114        "sound114"

#define SYN6658_SOUND_115        "sound115"

#define SYN6658_SOUND_116        "sound116"

#define SYN6658_SOUND_117        "sound117"

#define SYN6658_SOUND_118        "sound118"

#define SYN6658_SOUND_119        "sound119"

#define SYN6658_SOUND_120        "sound120"

#define SYN6658_SOUND_121        "sound121"

#define SYN6658_SOUND_122        "sound122"

#define SYN6658_SOUND_123        "sound123"

#define SYN6658_SOUND_124        "sound124"

#define SYN6658_SOUND_201        "sound201"

#define SYN6658_SOUND_202        "sound202"

#define SYN6658_SOUND_203        "sound203"

#define SYN6658_SOUND_204        "sound204"

#define SYN6658_SOUND_205        "sound205"

#define SYN6658_SOUND_206        "sound206"

#define SYN6658_SOUND_207        "sound207"

#define SYN6658_SOUND_208        "sound208"

#define SYN6658_SOUND_209        "sound209"

#define SYN6658_SOUND_210        "sound210"

#define SYN6658_SOUND_211        "sound211"

#define SYN6658_SOUND_212        "sound212"

#define SYN6658_SOUND_213        "sound213"

#define SYN6658_SOUND_214        "sound214"

#define SYN6658_SOUND_215        "sound215"

#define SYN6658_SOUND_216        "sound216"

#define SYN6658_SOUND_217        "sound217"

#define SYN6658_SOUND_218        "sound218"

#define SYN6658_SOUND_219        "sound219"

#define SYN6658_SOUND_301        "sound301"

#define SYN6658_SOUND_302        "sound302"

#define SYN6658_SOUND_303        "sound303"

#define SYN6658_SOUND_304        "sound304"

#define SYN6658_SOUND_305        "sound305"

#define SYN6658_SOUND_306        "sound306"

#define SYN6658_SOUND_307        "sound307"

#define SYN6658_SOUND_308        "sound308"

#define SYN6658_SOUND_309        "sound309"

#define SYN6658_SOUND_310        "sound310"

#define SYN6658_SOUND_311        "sound311"

#define SYN6658_SOUND_312        "sound312"

#define SYN6658_SOUND_313        "sound313"

#define SYN6658_SOUND_314        "sound314"

#define SYN6658_SOUND_315        "sound315"

#define SYN6658_SOUND_316        "sound316"

#define SYN6658_SOUND_317        "sound317"

#define SYN6658_SOUND_318        "sound318"

#define SYN6658_SOUND_319        "sound319"

#define SYN6658_SOUND_401        "sound401"

#define SYN6658_SOUND_402        "sound402"

#define SYN6658_SOUND_403        "sound403"

#define SYN6658_SOUND_404        "sound404"

#define SYN6658_SOUND_405        "sound405"

#define SYN6658_SOUND_406        "sound406"

#define SYN6658_SOUND_407        "sound407"

#define SYN6658_SOUND_408        "sound408"

#define SYN6658_SOUND_501        "sound501"

#define SYN6658_SOUND_502        "sound502"

#define SYN6658_SOUND_503        "sound503"

#define SYN6658_SOUND_504        "sound504"

#define SYN6658_SOUND_505        "sound505"

#define SYN6658_SOUND_506        "sound506"

#define SYN6658_SOUND_507        "sound507"

#define SYN6658_SOUND_601        "sound601"

#define SYN6658_SOUND_602        "sound602"

#define SYN6658_SOUND_701        "sound701"

#define SYN6658_SOUND_702        "sound702"

#define SYN6658_SOUND_703        "sound703"

#define SYN6658_SOUND_704        "sound704"

#define SYN6658_SOUND_705        "sound705"

#define SYN6658_SOUND_706        "sound706"

#define SYN6658_SOUND_707        "sound707"

#define SYN6658_SOUND_708        "sound708"

#define SYN6658_SOUND_709        "sound709"

#define SYN6658_SOUND_710        "sound710"

#define SYN6658_SOUND_711        "sound711"

#define SYN6658_SOUND_712        "sound712"

#define SYN6658_SOUND_713        "sound713"

#define SYN6658_SOUND_714        "sound714"

#define SYN6658_SOUND_715        "sound715"

#define SYN6658_SOUND_716        "sound716"

#define SYN6658_SOUND_717        "sound717"

#define SYN6658_SOUND_718        "sound718"

#define SYN6658_SOUND_719        "sound719"


#define SYN6658_MESSAGE_A        "msga"

#define SYN6658_MESSAGE_B        "msgb"

#define SYN6658_MESSAGE_C        "msgc"

#define SYN6658_MESSAGE_D        "msgd"

#define SYN6658_MESSAGE_E        "msge"

#define SYN6658_MESSAGE_F        "msgf"

#define SYN6658_MESSAGE_G        "msgg"

#define SYN6658_MESSAGE_H        "msgh"

#define SYN6658_MESSAGE_I        "msgi"

#define SYN6658_MESSAGE_J        "msgj"

#define SYN6658_MESSAGE_K        "msgk"

#define SYN6658_MESSAGE_L        "msgl"

#define SYN6658_MESSAGE_M        "msgm"

#define SYN6658_MESSAGE_N        "msgn"


typedef enum

{

    SYN6658_INTERFACE_UART = 0x00,

    SYN6658_INTERFACE_SPI  = 0x01,

} syn6658_interface_t;


typedef enum

{

    SYN6658_TYPE_GB2312         = 0x00,

    SYN6658_TYPE_GBK            = 0x01,

    SYN6658_TYPE_BIG5           = 0x02,

    SYN6658_TYPE_UNICODE_LITTLE = 0x03,

    SYN6658_TYPE_UNICODE_BIG    = 0x04,

} syn6658_type_t;


typedef enum

{

    SYN6658_STATUS_OK   = 0x00,

    SYN6658_STATUS_BUSY = 0x01,

} syn6658_status_t;


typedef enum

{

    SYN6658_SPEAKER_XIAOLING    = 3,

    SYN6658_SPEAKER_YIXIAOJIAN  = 51,

    SYN6658_SPEAKER_YIXIAOQIANG = 52,

    SYN6658_SPEAKER_TIANPEIPEI  = 53,

    SYN6658_SPEAKER_TANGLAOYA   = 54,

    SYN6658_SPEAKER_XIAOYANZI   = 55,

} syn6658_speaker_t;


typedef struct syn6658_handle_s

{

    uint8_t (*gpio_ready_init)(void);

    uint8_t (*gpio_ready_deinit)(void);

    uint8_t (*gpio_ready_read)(uint8_t *value);

    uint8_t (*uart_init)(void);

    uint8_t (*uart_deinit)(void);

    uint16_t (*uart_read)(uint8_t *buf, uint16_t len);

    uint8_t (*uart_flush)(void);

    uint8_t (*uart_write)(uint8_t *buf, uint16_t len);

    uint8_t (*spi_init)(void);

    uint8_t (*spi_deinit)(void);

    uint8_t (*spi_transmit)(uint8_t *tx, uint8_t *rx, uint16_t len);

    void (*delay_ms)(uint32_t ms);

    void (*debug_print)(const char *const fmt, ...);

    uint8_t inited;

    uint8_t uart_spi;

    uint8_t type;

    uint8_t buf[4096];

} syn6658_handle_t;


typedef struct syn6658_info_s

{

    char chip_name[32];

    char manufacturer_name[32];

    char interface[16];

    float supply_voltage_min_v;

    float supply_voltage_max_v;

    float max_current_ma;

    float temperature_min;

    float temperature_max;

    uint32_t driver_version;

} syn6658_info_t;


#define DRIVER_SYN6658_LINK_INIT(HANDLE, STRUCTURE)               memset(HANDLE, 0, sizeof(STRUCTURE))


#define DRIVER_SYN6658_LINK_UART_INIT(HANDLE, FUC)               (HANDLE)->uart_init = FUC


#define DRIVER_SYN6658_LINK_UART_DEINIT(HANDLE, FUC)             (HANDLE)->uart_deinit = FUC


#define DRIVER_SYN6658_LINK_UART_READ(HANDLE, FUC)               (HANDLE)->uart_read = FUC


#define DRIVER_SYN6658_LINK_UART_WRITE(HANDLE, FUC)              (HANDLE)->uart_write = FUC


#define DRIVER_SYN6658_LINK_UART_FLUSH(HANDLE, FUC)              (HANDLE)->uart_flush = FUC


#define DRIVER_SYN6658_LINK_SPI_INIT(HANDLE, FUC)                (HANDLE)->spi_init = FUC


#define DRIVER_SYN6658_LINK_SPI_DEINIT(HANDLE, FUC)              (HANDLE)->spi_deinit = FUC


#define DRIVER_SYN6658_LINK_SPI_TRANSMIT(HANDLE, FUC)            (HANDLE)->spi_transmit = FUC


#define DRIVER_SYN6658_LINK_GPIO_READY_INIT(HANDLE, FUC)         (HANDLE)->gpio_ready_init = FUC


#define DRIVER_SYN6658_LINK_GPIO_READY_DEINIT(HANDLE, FUC)       (HANDLE)->gpio_ready_deinit = FUC


#define DRIVER_SYN6658_LINK_GPIO_READY_READ(HANDLE, FUC)         (HANDLE)->gpio_ready_read = FUC


#define DRIVER_SYN6658_LINK_DELAY_MS(HANDLE, FUC)                (HANDLE)->delay_ms = FUC


#define DRIVER_SYN6658_LINK_DEBUG_PRINT(HANDLE, FUC)             (HANDLE)->debug_print = FUC


uint8_t syn6658_info(syn6658_info_t *info);


uint8_t syn6658_set_interface(syn6658_handle_t *handle, syn6658_interface_t interface);


uint8_t syn6658_get_interface(syn6658_handle_t *handle, syn6658_interface_t *interface);


uint8_t syn6658_init(syn6658_handle_t *handle);


uint8_t syn6658_deinit(syn6658_handle_t *handle);


uint8_t syn6658_set_text_type(syn6658_handle_t *handle, syn6658_type_t type);


uint8_t syn6658_get_text_type(syn6658_handle_t *handle, syn6658_type_t *type);


uint8_t syn6658_synthesis_text(syn6658_handle_t *handle, const char *const fmt, ...);


uint8_t syn6658_get_status(syn6658_handle_t *handle, syn6658_status_t *status);


uint8_t syn6658_stop(syn6658_handle_t *handle);


uint8_t syn6658_pause(syn6658_handle_t *handle);


uint8_t syn6658_resume(syn6658_handle_t *handle);


uint8_t syn6658_standby(syn6658_handle_t *handle);


uint8_t syn6658_wake_up(syn6658_handle_t *handle);


uint8_t syn6658_set_synthesis_volume(syn6658_handle_t *handle, uint8_t volume);


uint8_t syn6658_set_synthesis_speed(syn6658_handle_t *handle, uint8_t speed);


uint8_t syn6658_set_synthesis_speaker(syn6658_handle_t *handle, syn6658_speaker_t speaker);


uint8_t syn6658_save_text(syn6658_handle_t *handle, uint8_t offset, char *text);


uint8_t syn6658_play_text(syn6658_handle_t *handle, uint8_t times, syn6658_type_t type);


uint8_t syn6658_set_command(syn6658_handle_t *handle, uint8_t command, uint32_t timeout);


uint8_t syn6658_set_command_with_arg(syn6658_handle_t *handle, uint8_t command, uint8_t param, char *txt, uint32_t timeout);


#ifdef __cplusplus

}

#endif


#endif

syn6658_info_t
struct syn6658_info_s syn6658_info_t
syn6658 information structure definition

syn6658_info
uint8_t syn6658_info(syn6658_info_t *info)
get chip's information
Definition driver_syn6658.c:1353

syn6658_init
uint8_t syn6658_init(syn6658_handle_t *handle)
initialize the chip
Definition driver_syn6658.c:221

syn6658_play_text
uint8_t syn6658_play_text(syn6658_handle_t *handle, uint8_t times, syn6658_type_t type)
play text
Definition driver_syn6658.c:1150

syn6658_set_synthesis_speaker
uint8_t syn6658_set_synthesis_speaker(syn6658_handle_t *handle, syn6658_speaker_t speaker)
set the synthesis speaker
Definition driver_syn6658.c:1060

syn6658_type_t
syn6658_type_t
syn6658 type enumeration definition
Definition driver_syn6658.h:199

syn6658_get_text_type
uint8_t syn6658_get_text_type(syn6658_handle_t *handle, syn6658_type_t *type)
get the chip text type
Definition driver_syn6658.c:867

syn6658_resume
uint8_t syn6658_resume(syn6658_handle_t *handle)
resume the chip
Definition driver_syn6658.c:639

syn6658_get_status
uint8_t syn6658_get_status(syn6658_handle_t *handle, syn6658_status_t *status)
get the current status
Definition driver_syn6658.c:403

syn6658_speaker_t
syn6658_speaker_t
syn6658 speaker enumeration definition
Definition driver_syn6658.h:220

syn6658_set_synthesis_speed
uint8_t syn6658_set_synthesis_speed(syn6658_handle_t *handle, uint8_t speed)
set the synthesis speed
Definition driver_syn6658.c:1020

syn6658_save_text
uint8_t syn6658_save_text(syn6658_handle_t *handle, uint8_t offset, char *text)
save text to the buffer
Definition driver_syn6658.c:1099

syn6658_standby
uint8_t syn6658_standby(syn6658_handle_t *handle)
set the chip to standby mode
Definition driver_syn6658.c:704

syn6658_set_synthesis_volume
uint8_t syn6658_set_synthesis_volume(syn6658_handle_t *handle, uint8_t volume)
set the chip synthesis volume
Definition driver_syn6658.c:979

syn6658_deinit
uint8_t syn6658_deinit(syn6658_handle_t *handle)
close the chip
Definition driver_syn6658.c:352

syn6658_handle_t
struct syn6658_handle_s syn6658_handle_t
syn6658 handle structure definition

syn6658_pause
uint8_t syn6658_pause(syn6658_handle_t *handle)
pause the chip
Definition driver_syn6658.c:573

syn6658_set_text_type
uint8_t syn6658_set_text_type(syn6658_handle_t *handle, syn6658_type_t type)
set the chip text type
Definition driver_syn6658.c:841

syn6658_synthesis_text
uint8_t syn6658_synthesis_text(syn6658_handle_t *handle, const char *const fmt,...)
synthesis the test
Definition driver_syn6658.c:896

syn6658_status_t
syn6658_status_t
syn6658 status enumeration definition
Definition driver_syn6658.h:211

syn6658_set_interface
uint8_t syn6658_set_interface(syn6658_handle_t *handle, syn6658_interface_t interface)
set the chip interface
Definition driver_syn6658.c:177

syn6658_get_interface
uint8_t syn6658_get_interface(syn6658_handle_t *handle, syn6658_interface_t *interface)
get the chip interface
Definition driver_syn6658.c:198

syn6658_interface_t
syn6658_interface_t
syn6658 interface enumeration definition
Definition driver_syn6658.h:190

syn6658_wake_up
uint8_t syn6658_wake_up(syn6658_handle_t *handle)
wake up the chip
Definition driver_syn6658.c:769

syn6658_stop
uint8_t syn6658_stop(syn6658_handle_t *handle)
stop the chip
Definition driver_syn6658.c:508

SYN6658_TYPE_UNICODE_BIG
@ SYN6658_TYPE_UNICODE_BIG
Definition driver_syn6658.h:204

SYN6658_TYPE_GB2312
@ SYN6658_TYPE_GB2312
Definition driver_syn6658.h:200

SYN6658_TYPE_BIG5
@ SYN6658_TYPE_BIG5
Definition driver_syn6658.h:202

SYN6658_TYPE_UNICODE_LITTLE
@ SYN6658_TYPE_UNICODE_LITTLE
Definition driver_syn6658.h:203

SYN6658_TYPE_GBK
@ SYN6658_TYPE_GBK
Definition driver_syn6658.h:201

SYN6658_SPEAKER_XIAOLING
@ SYN6658_SPEAKER_XIAOLING
Definition driver_syn6658.h:221

SYN6658_SPEAKER_TIANPEIPEI
@ SYN6658_SPEAKER_TIANPEIPEI
Definition driver_syn6658.h:224

SYN6658_SPEAKER_TANGLAOYA
@ SYN6658_SPEAKER_TANGLAOYA
Definition driver_syn6658.h:225

SYN6658_SPEAKER_YIXIAOQIANG
@ SYN6658_SPEAKER_YIXIAOQIANG
Definition driver_syn6658.h:223

SYN6658_SPEAKER_XIAOYANZI
@ SYN6658_SPEAKER_XIAOYANZI
Definition driver_syn6658.h:226

SYN6658_SPEAKER_YIXIAOJIAN
@ SYN6658_SPEAKER_YIXIAOJIAN
Definition driver_syn6658.h:222

SYN6658_STATUS_BUSY
@ SYN6658_STATUS_BUSY
Definition driver_syn6658.h:213

SYN6658_STATUS_OK
@ SYN6658_STATUS_OK
Definition driver_syn6658.h:212

SYN6658_INTERFACE_SPI
@ SYN6658_INTERFACE_SPI
Definition driver_syn6658.h:192

SYN6658_INTERFACE_UART
@ SYN6658_INTERFACE_UART
Definition driver_syn6658.h:191

syn6658_set_command_with_arg
uint8_t syn6658_set_command_with_arg(syn6658_handle_t *handle, uint8_t command, uint8_t param, char *txt, uint32_t timeout)
send the command with arg to the chip
Definition driver_syn6658.c:1199

syn6658_set_command
uint8_t syn6658_set_command(syn6658_handle_t *handle, uint8_t command, uint32_t timeout)
send the command to the chip
Definition driver_syn6658.c:1284

syn6658_handle_s
syn6658 handle structure definition
Definition driver_syn6658.h:233

syn6658_handle_s::uart_flush
uint8_t(* uart_flush)(void)
Definition driver_syn6658.h:240

syn6658_handle_s::inited
uint8_t inited
Definition driver_syn6658.h:247

syn6658_handle_s::type
uint8_t type
Definition driver_syn6658.h:249

syn6658_handle_s::uart_write
uint8_t(* uart_write)(uint8_t *buf, uint16_t len)
Definition driver_syn6658.h:241

syn6658_handle_s::spi_init
uint8_t(* spi_init)(void)
Definition driver_syn6658.h:242

syn6658_handle_s::delay_ms
void(* delay_ms)(uint32_t ms)
Definition driver_syn6658.h:245

syn6658_handle_s::gpio_ready_read
uint8_t(* gpio_ready_read)(uint8_t *value)
Definition driver_syn6658.h:236

syn6658_handle_s::uart_deinit
uint8_t(* uart_deinit)(void)
Definition driver_syn6658.h:238

syn6658_handle_s::gpio_ready_init
uint8_t(* gpio_ready_init)(void)
Definition driver_syn6658.h:234

syn6658_handle_s::buf
uint8_t buf[4096]
Definition driver_syn6658.h:250

syn6658_handle_s::debug_print
void(* debug_print)(const char *const fmt,...)
Definition driver_syn6658.h:246

syn6658_handle_s::spi_transmit
uint8_t(* spi_transmit)(uint8_t *tx, uint8_t *rx, uint16_t len)
Definition driver_syn6658.h:244

syn6658_handle_s::uart_spi
uint8_t uart_spi
Definition driver_syn6658.h:248

syn6658_handle_s::spi_deinit
uint8_t(* spi_deinit)(void)
Definition driver_syn6658.h:243

syn6658_handle_s::uart_read
uint16_t(* uart_read)(uint8_t *buf, uint16_t len)
Definition driver_syn6658.h:239

syn6658_handle_s::gpio_ready_deinit
uint8_t(* gpio_ready_deinit)(void)
Definition driver_syn6658.h:235

syn6658_handle_s::uart_init
uint8_t(* uart_init)(void)
Definition driver_syn6658.h:237

syn6658_info_s
syn6658 information structure definition
Definition driver_syn6658.h:257

syn6658_info_s::temperature_max
float temperature_max
Definition driver_syn6658.h:265

syn6658_info_s::supply_voltage_max_v
float supply_voltage_max_v
Definition driver_syn6658.h:262

syn6658_info_s::driver_version
uint32_t driver_version
Definition driver_syn6658.h:266

syn6658_info_s::interface
char interface[16]
Definition driver_syn6658.h:260

syn6658_info_s::temperature_min
float temperature_min
Definition driver_syn6658.h:264

syn6658_info_s::max_current_ma
float max_current_ma
Definition driver_syn6658.h:263

syn6658_info_s::manufacturer_name
char manufacturer_name[32]
Definition driver_syn6658.h:259

syn6658_info_s::supply_voltage_min_v
float supply_voltage_min_v
Definition driver_syn6658.h:261

syn6658_info_s::chip_name
char chip_name[32]
Definition driver_syn6658.h:258