Diff: ATP301x_SPI.h

Revision:

0:afac3f0b332e

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ATP301x_SPI.h	Fri May 22 09:01:32 2020 +0000
@@ -0,0 +1,83 @@
+#ifndef ATP301X_SPI_H
+#define ATP301X_SPI_H
+
+#include "mbed.h"
+
+/** 動作パラメータ設定
+* ※カッコ内はデータシートに記載された限度値です。
+*/
+ 
+//最大文字数制限 (<= 127バイト-2バイト('.'＋'\r'))
+#define ATP_MAX_LEN 125
+
+//発話中ポーリング周期(ms) (>= 10ms)
+#define POLLING_CYCLE_MS 20
+
+//SPI通信クロック (<= 1MHz)
+#define SPI_CLK_HZ 500000
+
+//SPI送信周期 (>= 20μs)
+#define SPI_SEND_PERIOD_US 25
+
+#include "mbed.h"
+
+
+/** ATP301x_SPI class.
+*  I wrote all documentation and comment in Japanese language only.
+*　(本ライブラリのドキュメントとコメントは日本語でのみ記載しております。)
+*  
+*  ATP301x series speech processor can only speak Japanese, so I thought this library will be used only in Japan.
+*  (ATP301x シリーズの音声合成LSIは日本語専用であり、本ライブラリは日本でのみ使用されることが想定されるためです。)
+*  
+*  AquesTalk pico 日本語音声合成LSI ATP3011/ATP3012 をSPI通信で使用するためのライブラリです。
+*  
+*  SPI通信モードは内部で3に固定しています。
+*  
+*  動作パラメータはATP301x_SPI.hのマクロで定義しています。必要に応じ変更してご使用ください。
+*/
+class ATP301x_SPI{
+public:
+    /** 
+     * @param mosi SPI mosiピン
+     * @param miso SPI misoピン
+     * @param sck SPI sckピン
+     * @param ss SPI ssピン(DigitalOutを使用)
+     */
+    ATP301x_SPI(PinName mosi, PinName miso, PinName sck, PinName ss);
+    
+    /**
+     * @brief breakコマンドを送信し発話中断します。ATP301xが次のコマンドを受け付けられる状態になる(Readyになる)までwait()します。
+     */
+    void stop();
+    
+    /**
+     * @brief ATP301xに音声コマンドを送信します。NULL/\o/0xFF終端(音声記号を受け取った場合、文末記号であるピリオドでbreak)に対応します。
+     * ATP301xへ送信するコマンド終端を表す最後のキャレッジリターンは自動付与します。
+     * @param input[] ATP301xへ送信するデータのchar配列(音声記号 または 制御コマンド)
+     * ※音声記号が ATP_MAX_LEN で指定する文字数を超えた場合、ATP301xが受け取れる文字数を超えてしまうため送信を強制終了します。
+     * 文字数オーバーとなった場合、運よく音声記号が成立する位置でカットされた場合は途中まで発話されますが、
+     * 音声記号が成立しない位置でカット（例：子音で終了）された場合は警告メッセージのみが発話されます。
+     * @param useWait コマンド送信後、送ったコマンドを発話終了まで(＝ATP301xがReadyになるまで) waitするか指定(デフォルト:true)
+     * ※割り込み等で発話中にstop()が呼ばれた場合、useWaitによらずbreakコマンドを送信し発話を中止します。
+     */
+    void talk(char input[], bool useWait = true);
+    
+    /**
+     * @brief ATP301xの内蔵チャイムJを鳴らします。
+     * @param useWait trueの場合、チャイム再生終了まで(＝ATP301xがReadyになるまで) wait()します。(デフォルト:true)
+     */
+    void chimeJ(bool useWait = true);
+    
+    /**
+     * @brief ATP301xの内蔵チャイムKを鳴らします。
+     * @param useWait trueの場合、チャイム再生終了まで(＝ATP301xがReadyになるまで) wait()します。(デフォルト:true)
+     */
+    void chimeK(bool useWait = true);
+
+private:
+    SPI _spi; // mosi, miso, sck
+    DigitalOut _ss;
+    void atp_initialize();
+    void atp_wait();
+};
+#endif
\ No newline at end of file