Add Example

Author: mongonta0716

README.md

@@ -1,2 +1,24 @@
 # stackchan-arduino
 Stack Chan Library for ArduinoFramework
+
+# 使い方
+
+platformio.iniのlib_depsに下記の記述を追加してください。(そのうち公開します。)
+
+```
+lib_deps = 
+  m5stack/M5Unified@0.1.16
+  arminjo/ServoEasing@^2.4.0
+  madhephaestus/ESP32Servo @ 0.13.0
+  bblanchon/ArduinoJson @ ^6
+  tobozo/YAMLDuino
+  https://github.com/mongonta0716/stackchan-arduino.git
+  https://github.com/mongonta0716/SCServo
+lib_ldf_mode = deep                                       ; これを忘れるとリンクエラーになります。
+```
+
+# 設定ファイル
+- [SC_BasicConfig.yaml](./data/yaml/SC_BasicConfig.yaml)<br>ｽﾀｯｸﾁｬﾝを起動するために必要な基本的なパラメータを集めています。
+- [SC_SecConfig.yaml](./data/yaml/SC_SecConfig.yaml)<br>個人情報用の設定ファイルです。(WiFiやAPIKey等)
+- [SC_ExConfig.yaml](./data/yaml/SC_ExConfig.yaml)<br>アプリケーション側で、設定を追加したいときに使用します。使い方はexamples/Advanceを参照してください。
+

data/yaml/SC_ExtConfig.yaml

@@ -1,2 +1,14 @@
-# アプリケーションで利用する設定を書きます。
-role:
+# 各アプリケーションで利用する設定を書きます。
+# '#'を使うとコメントとして働きます。
+app_parameters1:
+    item1: "アイテム1のデータ"      # 文字列
+    item2: 123456789                # 数値
+    item3: True                     # True or False or 0 or 1
+
+app_parameters2:
+    item4: "リストのサンプル"
+    list_str: # リストの書き方1
+    - "文字列1"
+    - "文字列2"
+    - "文字列3"
+    list_num: [ 1, -2, 3, -4]    # リストの書き方2

data/yaml/SC_SecConfig.yaml

@@ -1,3 +1,4 @@
+# 個人情報用の設定ファイル
 wifi:
   ssid: "YOUR_WIFI_SSID"
   password: "YOUR_WIFI_PASSWORD"

examples/Basic/platformio.ini

@@ -0,0 +1,29 @@
+[platformio]
+default_envs = m5stack-core2
+
+[env]
+platform = espressif32 @ 6.5.0 
+framework = arduino
+upload_speed = 1500000
+monitor_speed = 115200
+board_build.f_flash = 80000000L
+board_build.filesystem = spiffs
+board_build.partitions = default_16MB.csv
+build_flags = -DCORE_DEBUG_LEVEL=4
+lib_deps = 
+
+lib_deps = 
+  m5stack/M5Unified@0.1.16
+  arminjo/ServoEasing@^2.4.0
+  madhephaestus/ESP32Servo @ 0.13.0
+  bblanchon/ArduinoJson @ ^6
+  tobozo/YAMLDuino
+  https://github.com/mongonta0716/stackchan-arduino.git
+  https://github.com/mongonta0716/SCServo
+lib_ldf_mode = deep                                       ; これを忘れるとリンクエラーになります。
+
+[env:m5stack-core2]
+board = m5stack-conre2
+
+[env:m5stack-cores3]
+board = m5stack-cores3

examples/Basic/src/Stackchan_ex_config.cpp

@@ -0,0 +1,53 @@
+
+#include "Stackchan_ex_config.h"
+
+StackchanExConfig::StackchanExConfig() {};
+StackchanExConfig::~StackchanExConfig() {};
+
+void StackchanConfig::loadExtendConfig(fs::FS& fs, const char *yaml_filename, uint32_t yaml_size) {
+    M5_LOGI("----- StackchanExConfig::loadConfig:%s\n", yaml_filename);
+    File file = fs.open(yaml_filename);
+    if (file) {
+        DynamicJsonDocument doc(yaml_size);
+        auto err = deserializeYml( doc, file);
+        if (err) {
+            M5_LOGE("yaml file read error: %s\n", yaml_filename);
+            M5_LOGE("error%s\n", err.c_str());
+        }
+        serializeJsonPretty(doc, Serial);
+        setExtendSettings(doc);
+    }
+}
+
+void StackchanExConfig::setExtendSettings(DynamicJsonDocument doc) {
+    JsonObject app_param1 = doc["app_parameters1"];
+    _ex_parameters.item1 = app_param1["item1"].as<String>();            // 文字列はこのように記述
+    _ex_parameters.item2 = app_param1["item2"]                          // 数値
+    _ex_parameters.item3 = app_param1["item3"].as<bool>();              // True/False/0/1 
+    JsonObject app_param2 = doc["app_parameters2"];
+
+    JsonArray list_str = app_param2["list_str"];
+    _list_str_count = list_str.size();
+    for (int i=0; i<_list_str_count; i++) {
+        _list_str[i] = list_str[i].as<String>();
+    }
+    JsonArray list_num = app_param2["list_num"];
+    _list_num_count = list_num.size();
+    for (int i=0; i<_list_num_count; i++) {
+        _list_num[i] = list_num[i];
+    }
+}
+
+
+void StackchanExConfig::printExtParameters(void) {
+    M5_LOGI("item1:%s\n", _ex_parameters.item1.c_str());
+    M5_LOGI("item2:%d\n", _ex_parameters.item2);
+    M5_LOGI("item3:%s\n", _ex_parameters.item3 ? "true":"false");
+    M5_LOGI("item4:%s\n", _item4);
+    for (int i=0; i<_list_str_count; i++) {
+        M5_LOGI("list_str[%d]: %s\n", i, _list_str[i]);
+    }
+    for (int i=0; i<_list_num_count; i++) {
+        M5_LOGI("list_num[%d]: %d\n", i, _list_num[i]);
+    }
+}

examples/Basic/src/Stackchan_ex_config.h

@@ -0,0 +1,42 @@
+#ifndef __STACKCHAN_EX_CONFIG_H__
+#define __STACKCHAN_EX_CONFIG_H__
+
+#include <Stackchan_system_config.h>
+
+typedef struct ExConfig {
+    String item1;
+    int    item2;
+    bool   item3;
+} ex_config_s;
+
+
+// StackchanSystemConfigを継承します。
+class StackchanExConfig : public StackchanSystemConfig
+{
+    protected:
+        ex_config_s _ex_parameters;
+        String  _item4;
+        uint8_t _list_str_count;
+        String  _list_str[10];
+        uint8_t _list_num_count;
+        int     _list_num[10];
+
+    public:
+        StackchanExConfig();
+        ~StackchanExConfig();
+
+        void loadExtendConfig(fs::FS& fs, const char *yaml_filename, uint32_t yaml_size) override;
+        void setExtendSettings(DynamicJsonDocument doc) override;
+        void printExtParameters(void) override;
+        ex_config_s getExConfig() { return _ex_parameters; }
+        uint8_t getListStrCount() { return _list_str_count; }
+        String getListStr(uint8_t no) { return _list_str[no]; }
+        uint8_t getListNumCount() { return _list_num_count; }
+        int    getListNum(uint8_t no) { return _list_num[no]; }
+        void setItem1(String item1) { _ex_parameters.item1 = item1; }
+        void setItem2(int    item2) { _ex_parameters.item2 = item2; }
+        void setItem3(bool   item3) { _ex_parameters.item3 = item3; }
+        void setExConfig(ex_config_s config) { _ex_parameters = config; } 
+};
+
+#endif // __STACKCHAN_EX_CONFIG_H__

examples/Basic/src/main.cpp

@@ -0,0 +1,22 @@
+#include <Arduino.h>
+#include <M5Unified.h>
+#include <SD.h>
+#include "Stackchan_ex_config.h"
+
+StackchanExConfig config;
+
+void setup() {
+  auto cfg = M5.config();
+  M5.begin(cfg);
+  M5.Log.setLogLevel(m5::log_target_display, ESP_LOG_INFO);
+  M5.Log.setEnableColor(m5::log_target_serial, false);
+  SD.begin(GPIO_NUM_4, SPI, 25000000);
+  delay(2000);
+  config.loadConfig(SD, "/yaml/SC_BasicConfig.yaml");
+
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+}
+

src/AIStackchan_config.cpp

@@ -191,7 +191,7 @@ void StackchanSystemConfig::printAllParameters() {
     M5_LOGI("use takao_base:%s\n", _takao_base ? "true":"false");
     M5_LOGI("ServoTypeStr:%s\n", _servo_type_str.c_str());
     M5_LOGI("ServoType: %d\n", _servo_type);
-    M5_LOGI("ExtendConfigFileName: %s\n", _extend_config_filename);
+    M5_LOGI("ExtendConfigFileName: %s\n", _extend_config_filename.c_str());
     M5_LOGI("ExtendConfigFileSize: %d\n", _extend_config_filesize);
 
     printExtParameters();