Skip to content

Commit 377a720

Browse files
mongonta0716mongonta0716
committed
Fixed minor details for release.
1 parent 55deb91 commit 377a720

File tree

6 files changed

+103
-18
lines changed

6 files changed

+103
-18
lines changed

‎README.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,64 @@
11
# stackchan-arduino
22
Stack Chan Library for ArduinoFramework
3+
Arduino Frameworkで利用できるStackchan用のライブラリです。
4+
5+
日本語 | [English](./README_en.md)
36

47
# 使い方
58

6-
platformio.iniのlib_depsに下記の記述を追加してください。(そのうち公開します。)
9+
platformio.iniのlib_depsに下記の記述を追加してください。
710

811
```
912
lib_deps =
10-
https://github.com/mongonta0716/stackchan-arduino.git
13+
stack-chan/stackchan-arduino@^0.0.1
1114
lib_ldf_mode = deep ; これを忘れるとリンクエラーになります。
1215
```
1316

17+
# 機能
18+
- 設定ファイルの読み込み機能<br>後述の設定ファイルを読み込んで設定を変更することができます。<br>Stackchan_system_config.hをincludeします。
19+
- サーボのコントロール機能<br>現在3種類のサーボを設定で切り替えてコントロールすることが可能です。<br>Stackchan_servo.hをincludeします。
20+
- PWM<br>SG90等のPWMサーボ
21+
- SCS<br>Feetech SCS0009 シリアルサーボ
22+
- DYN_XL330<br>Dynamixel XL330-M288-T
23+
- 【未実装】Stack-chan_Takao_Baseの状態監視<br>Stack-chan_Takao_Baseを使うための便利な機能を実装予定です。
24+
25+
# 使い方
26+
- [Basic](./examples/Basic/)パラメータの読み込み方法はこちらを見てください。
27+
- [stack-chan-tester](https://github.com/mongonta0716/stack-chan-tester)サーボと
28+
1429
# 設定ファイル
15-
設定内容は各ファイルに詳しくコメントしています。
30+
設定内容は各ファイルに詳しくコメントしています。YAML形式で記述してください。<br>※ YAMLを利用しているのはコメントを記述できる点が便利だからです。
1631
- [SC_BasicConfig.yaml](./data/yaml/SC_BasicConfig.yaml)<br>ｽﾀｯｸﾁｬﾝを起動するために必要な基本的なパラメータを集めています。
1732
- [SC_SecConfig.yaml](./data/yaml/SC_SecConfig.yaml)<br>個人情報用の設定ファイルです。(WiFiやAPIKey等)
18-
- [SC_ExConfig.yaml](./data/yaml/SC_ExConfig.yaml)<br>アプリケーション側で、設定を追加したいときに使用します。使い方はexamples/Advanceを参照してください。
33+
- [SC_ExConfig.yaml](./data/yaml/SC_ExConfig.yaml)<br>アプリケーション側で、設定を追加したいときに使用します。使い方は[Folder](./examples/Basic/)のソースを参照してください。
34+
35+
# 必要なライブラリ
36+
37+
詳細のバージョンは[library.json](./library.json)のdependenciesを参照してください。ArduinoIDEで利用する場合はバージョンを最新にしてしまうとビルドできなくなったり、動かなくなる場合があります。PlatformIOを推奨します。
38+
- [M5Unified](https://github.com/m5stack/M5Unified)
39+
- [ESP32Servo](https://github.com/madhephaestus/ESP32Servo)
40+
- [ServoEasing](https://github.com/ArminJo/ServoEasing)
41+
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson)
42+
- [Dynamixel2Arduino](https://github.com/ROBOTIS-GIT/Dynamixel2Arduino)
43+
- [YAMLDuino](https://github.com/tobozo/YAMLDuino)
44+
- [SCServo](https://github.com/mongonta0716/SCServo)
45+
46+
47+
# ｽﾀｯｸﾁｬﾝについて
48+
49+
ｽﾀｯｸﾁｬﾝは[ししかわさん](https://github.com/stack-chan)が公開しているオープンソースのプロジェクトです。
50+
https://github.com/stack-chan/stack-chan
51+
52+
# Credit
53+
- [meganetaaan](https://github.com/meganetaaan)
54+
- [lovyan03](https://github.com/lovyan03/LovyanGFX)
55+
- [robo8080](https://github.com/robo8080)
56+
- [tobozo](https://github.com/tobozo)
57+
58+
# LICENCE
59+
60+
[MIT](./LICENSE)
61+
62+
# Author
1963

64+
[Takao Akaki](https://github.com/mongonta0716)

‎README_en.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# stackchan-arduino
2+
Stack Chan Library for ArduinoFramework
3+
4+
[日本語](./README.md) | English
5+
6+
# 使い方
7+
8+
platformio.iniのlib_depsに下記の記述を追加してください。
9+
10+
```
11+
lib_deps =
12+
stack-chan/stackchan-arduino@^0.0.1
13+
lib_ldf_mode = deep ; これを忘れるとリンクエラーになります。
14+
```
15+
16+
# 機能
17+
- 設定ファイルの読み込み機能<br>後述の設定ファイルを読み込んで設定を変更することができます。<br>Stackchan_system_config.hをincludeします。
18+
- サーボのコントロール機能<br>現在3種類のサーボを設定で切り替えてコントロールすることが可能です。<br>Stackchan_servo.hをincludeします。
19+
- PWM<br>SG90等のPWMサーボ
20+
- SCS<br>Feetech SCS0009 シリアルサーボ
21+
- DYN_XL330<br>Dynamixel XL330-M288-T
22+
- 【未実装】Stack-chan_Takao_Baseの状態監視<br>Stack-chan_Takao_Baseを使うための便利な機能を実装予定です。
23+
24+
25+
# 設定ファイル
26+
設定内容は各ファイルに詳しくコメントしています。
27+
- [SC_BasicConfig.yaml](./data/yaml/SC_BasicConfig.yaml)<br>ｽﾀｯｸﾁｬﾝを起動するために必要な基本的なパラメータを集めています。
28+
- [SC_SecConfig.yaml](./data/yaml/SC_SecConfig.yaml)<br>個人情報用の設定ファイルです。(WiFiやAPIKey等)
29+
- [SC_ExConfig.yaml](./data/yaml/SC_ExConfig.yaml)<br>アプリケーション側で、設定を追加したいときに使用します。使い方は[Folder](./examples/Basic/)のソースを参照してください。
30+
31+
# LICENCE
32+
33+
[MIT](./LICENSE)
34+
35+
# Author
36+
37+
[Takao Akaki](https://github.com/mongonta0716)

‎data/yaml/SC_BasicConfig.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ servo:
55
# Core2 PortA X:33,Y:32 PortC X:13,Y:14
66
# CoreS3 PortA X:2, Y:1 PortB X:9, Y:8 PortC X:17, Y:18
77
# Stack-chanPCB Core1 X:5,Y:2 Core2 X:19,Y27
8-
# When using SCS0009 or Dynamixel XL330, x:RX, y:TX (not used).(StackchanRT Version:Core1 x16,y17, Core2: x13,y14)
8+
# When using SCS0009 or Dynamixel XL330, x:RX, y:TX (not used)
99
x: 17
1010
y: 18
1111
offset:
@@ -21,12 +21,18 @@ servo:
2121
y: 90
2222
lower_limit:
2323
# 可動範囲の下限（下限と言っても取り付け方により逆の場合あり, 値の小さい方を指定。）
24+
# SG90: x:0, y:60
25+
# SCS0009: x:0, y:120
26+
# Dynamixel XL330: x:0, y:220
2427
x: 0
2528
y: 60
2629
upper_limit:
2730
# 可動範囲の上限（上限と言っても取り付け方により逆の場合もあり, 値の大きい方を指定。）
31+
# SG90: x:180, y:90
32+
# SCS0009: x:300, y:150
33+
# Dynamixel XL330: x:360, y:270
2834
x: 90
29-
y: 100
35+
y: 90
3036
speed:
3137
normal_mode:
3238
interval_min: 3000
@@ -38,6 +44,10 @@ servo:
3844
interval_max: 1000
3945
move_min: 500
4046
move_max: 1000
47+
takao_base: false # Whether to use takaobase to feed power from the rear connector.(Stack-chan_Takao_Base https://ssci.to/8905)
48+
servo_type: "PWM" # "PWM": SG90PWMServo, "SCS": Feetech SCS0009 "DYN_XL330": Dynamixel XL330
49+
50+
### 以下はアプリケーションによって設定が変わります。
4151
bluetooth:
4252
device_name: "M5StackBTSPK"
4353
starting_state: false
@@ -56,8 +66,6 @@ balloon:
5666
- "Je suis Stack-chan"
5767
led_lr: 0 # 0:stereo, 1:left_only, 2:right_only
5868
led_pin: 15 # GoBottom1:15 GoBottom2:25
59-
takao_base: false # Whether to use takaobase to feed power from the rear connector.(Stack-chan_Takao_Base https://ssci.to/8905)
60-
servo_type: "PWM" # "PWM": SG90PWMServo, "SCS": Feetech SCS0009 "DYN_XL330": Dynamixel XL330
6169

6270
# 下記は拡張用の設定ファイルを使用する場合に設定します。(初期値はありません。)
6371
extend_config_filename: "" # "/yaml/SC_ExConfig.yaml" # Configuration file for the application.

‎examples/Basic/platformio.ini

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,7 @@ lib_deps =
1414

1515
lib_deps =
1616
m5stack/[email protected]
17-
arminjo/ServoEasing@^2.4.0
18-
madhephaestus/ESP32Servo @ 0.13.0
19-
bblanchon/ArduinoJson @ ^6
20-
tobozo/YAMLDuino
21-
https://github.com/mongonta0716/stackchan-arduino.git
22-
https://github.com/mongonta0716/SCServo
17+
stack-chan/stackchan-arduino.git
2318
lib_ldf_mode = deep ; これを忘れるとリンクエラーになります。
2419

2520
[env:m5stack-core2]

‎library.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "Stackchan-arduino",
2+
"name": "stackchan-arduino",
33
"keywords": "stackchan, servo, M5Stack",
44
"description": "An M5Stack library for Stackchan",
55
"repository": {
66
"type": "git",
7-
"url": "https://github.com/mongonta0716/stackchan-arduino.git"
7+
"url": "https://github.com/stack-chan/stackchan-arduino.git"
88
},
99
"authors": [
1010
{

‎library.properties

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name=Stackchan_arduino
1+
name=stackchan-arduino
22
version=0.0.1
33
author=Takao Akaki
44
maintainer=Takao Akaki<[email protected]>
55
sentence=Stackchan library for M5Stack
66
paragraph=See more on http://M5Stack.com
77
category=Device Control
8-
url=https://platformio.org/lib/show/4529/M5Stack-Avatar
8+
url=https://github.com/stack-chan/stackchan-arduino
99
architectures=esp32
1010
includes=Stackchan_servo.h, Stackchan_system_config.h

0 commit comments

Comments
 (0)