Developers（ソフトウエア開発者の方へ）
ソフト開発者の方向け、内部的な情報を記載します。
０．LICENSE
作成したソースファイルは、ファイル名の先頭に "ws" を付けています。
本ソフトウエアは、主に下記のソフトを参考にして作成しました。
・ AI_StackChan2 (robo8080さん)
・ stack-chan-tester(タカオさん)
・ ESP-File-Server（David Bird: UK）
本ソフトのライセンスは、
MITライセンスです。（文章添付）
AI_StackChan2、stack-chan-tester と同じライセンスです。
ただし、ESP-File-Server（David Bird: UK）は、個別のライセンスを指定しています。
GitHubの "doc/ESP-File-Server-License.txt"を読んで、ご自分の責任でご利用ください。
（ 該当ソース・ファイルは、"src/base00/
wsServer.cpp" です。）
-------------------------------------------------------------------
MIT License
Copyright (c) 2023 NoRi
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-------------------------------------------------------------------
１．Wifiの接続設定の順番
WiFiの接続設定の優先順位
１．SD直下の設定ファイル "wsWifi.json"
２．SD直下の設定ファイル "wifi.txt" ...AiStackChan2仕様ファイル
３．SPIFFS領域の設定ファイル "wsWifi.json"
４．前回の接続情報を使う
５．SmartConfig
１〜５の順番に接続を試みます。ファイルが存在しない場合は次の順番に移ります。
２．SD問題のいちおうの解決
ファイルマネージメントの機能として、SPIFFSは当初から対応していたのですが、SDにも対応しようとソースを変更したのですが、最初は、あまりにも内部エラーを吐き出すのが多くて一時は、あきらめてSPIFFSだけの対応でもしかたないかと考えて開発を進めていました。
改めて、SDの調査をして、いちおうの解決ができました。ポイントは、SDの最初の設定: SD.beginの設定をいじらなとダメでした。
SD.begin(GPIO_NUM_4, SPI, 15000000, "/sdcard", 10, false);
SDのファルダ機能に関しては、Ver302以降で対応しましたが、動作が不安定です。
参考程度としてください。
３．設定ファイルについて
設定ファイルは、SPIFFS領域にjson形式のファイルで設置しています。
・ wsApiKey.json ApiKeyデータ
・ wsWifi.json wifi接続情報
・ wsStartup.json スタートアップ時の設定
・ wsServo.json サーボ設定データ
・ data.json chatGPTのデータ
・ wsCharacter.json キャラクター変更に使用するロールデータ
電源をOnにしたとき、SPIFFS領域にファイルが読取れない場合に、初期データで設定ファイルを作成します。
設定を変更するには、次の２通りの方法があります。
・ webAppｓの Setting、Servoアプリを使用する (オンライン)
・ PCで設定ファイルを修正してから、本体にファイルをUploadする方法（オフライン）
オフラインで設定を変更するには、設定ファイルのサンプルをもとにPCでテキスト・エディター等で変更してください。その後、SPIFFSにアップしてください。
「WSS-Support 」の DownLoad から、サンプル・ファイルを入手することができます。
破損に備えて、最低でもwsApiKey.json, wsWifi.json ファイルはPCにバックアップを取っておくことをお勧めします。
４．webAppsの開発について
webApps (Webアプリ) は、htmlファイルで作成されて、本体のSPIFFSに配置されます。htmlファイルのほか、一般の StyleSheet(CSS), JavaScript, 画像ファイル等も使用できます。
webAppsのソフトは、VsCodeを使用して開発できます。ローカル・サーバー、javaScriptのデバッカー等の機能が使用できようになるので、PCで全ての開発環境が整います。
デバック完了後は、SPIFFSにファイルをUploadすれば、そのまま本体で動作させることができます。
外部サーバーにファイルを設置して動作させることも可能です。
ファームウエアとWebアプリを連携すると、特にユーザーインターフェースの開発が楽になり、開発効率が上がります。やりたいことが直ぐに実現できるようになります。
スタックチャン用のソフトだけでなく、一般のM5Stackのソフトウエア開発者にもお勧めします。
外部とのインターフェースを "webApi"フォルダに まとめています。
機能の追加やwebAppsを開発する場合には、ここのファイルに修正が必要です。
・wsApi.cpp
・wsUser.cpp
ファイルを見るとFimwareとWebアプリの連携は、どうしているかがわかると思います。