Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3110/m5stack-image-viewer
画面が付いているM5Stackシリーズ用の画像表示プログラムです。LittleFS/microSD上にある画像ファイルを次々に表示します。
https://github.com/3110/m5stack-image-viewer
littlefs m5stack m5unified platformio
Last synced: 2 months ago
JSON representation
画面が付いているM5Stackシリーズ用の画像表示プログラムです。LittleFS/microSD上にある画像ファイルを次々に表示します。
- Host: GitHub
- URL: https://github.com/3110/m5stack-image-viewer
- Owner: 3110
- License: mit
- Created: 2024-02-23T04:32:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-28T11:06:50.000Z (5 months ago)
- Last Synced: 2024-10-11T22:47:56.300Z (3 months ago)
- Topics: littlefs, m5stack, m5unified, platformio
- Language: C++
- Homepage:
- Size: 53.7 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[In English](README_en_US.md)
# M5Stackシリーズ用画像表示プログラム
M5Stackシリーズでファイルシステム（LittleFS，microSD）上にある画像を次々と表示するプログラムです。
以下の2種類の表示方法があります。
* 手動（Manul）モード
Aボタン（正順）・Cボタン（逆順）を押すたびに画像を切り替えて表示します。M5Dialの場合はダイヤルを左右（逆順・正順）に回すことで画像を切り替えます。
* 自動（Auto）モード
設定ファイルで指定した間隔（ミリ秒）で表示します。指定した表示間隔を最大値としたランダムの間隔で表示することもできます。
## コンパイル方法
[PlatformIO IDE](https://platformio.org/platformio-ide)環境でコンパイルします。機種に合わせて環境を選択してください。
`-sd`がついている環境ではLittleFSの代わりにmicroSDカードを使用します。
| 機種 | 環境 |
| :-------------- | :--------------------------|
| M5Stack BASIC | env:m5stack-basic(-sd) |
| M5Stack Fire | env:m5stack-fire(-sd) |
| M5Go | env:m5stack-m5go(-sd) |
| M5Stack Core2 | env:m5stack-core2(-sd) |
| M5Stack Core3 | env:m5stack-core3(-sd) |
| M5Stick C | env:m5stick-c |
| M5Stick C Plus | env:m5stick-c-plus |
| M5Stick C Plus2 | env:m5stick-c-plus2 |
| M5ATOM S3 | env:m5stack-atoms3 |
| M5Dial | env:m5stack-dial |
| M5Cardputer | env:m5stack-cardputer(-sd) |
| M5DinMeter | env:m5stack-din-meter |
| CoreInk | env:m5stack-coreink |
| M5Paper | env:m5stack-paper(-sd) |
デフォルトの表示の向きは機種ごとに違います。
| 機種 | 環境 | デフォルトの表示の向き |
| :-------------- | :--------------------------| :--------------------- |
| M5Stack BASIC | env:m5stack-basic(-sd) | 1 |
| M5Stack Fire | env:m5stack-fire(-sd) | 1 |
| M5Go | env:m5stack-m5go(-sd) | 1 |
| M5Stack Core2 | env:m5stack-core2(-sd) | 1 |
| M5Stack Core3 | env:m5stack-core3(-sd) | 1 |
| M5Stick C | env:m5stick-c | 0 |
| M5Stick C Plus | env:m5stick-c-plus | 0 |
| M5Stick C Plus2 | env:m5stick-c-plus2 | 0 |
| M5ATOM S3 | env:m5stack-atoms3 | 0 |
| M5Dial | env:m5stack-dial | 0 |
| M5Cardputer | env:m5stack-cardputer(-sd) | 1 |
| M5DinMeter | env:m5stack-din-meter | 0 |
| CoreInk | env:m5stack-coreink | 0 |
| M5Paper | env:m5stack-paper(-sd) | 1 |
## 設定ファイル
設定ファイル`data/image-viewer.json`で以下を設定できます。
* `AutoMode`
自動表示モードのオン（`true`）・オフ（`false`）
* `AutoModeInterval`
自動表示モードのときの画像の切り替え間隔（ミリ秒）
* `AutoModeRandomized`
ランダム切り替え間隔モードのオン（`true`）・オフ（`false`）
* `AutoRotation`
IMUを内蔵している機種で表示を自動的に向きに追従させるか（`true`）・追従させないか（`false`）
* `Orientation`
表示の向き（[`M5GFX::setRotation()`](https://docs.m5stack.com/ja/arduino/m5gfx/m5gfx_functions#setrotation)に渡す値）
設定ファイルがない場合は，自動モードはオフ（`false`），切り替え間隔は 3 秒（3000 ミリ秒），ランダム切り替え間隔モードはオフ（`false`），画面の向きに追従させる（`true`），表示の向きはデフォルトの表示の向きになります。
```json
{
"AutoMode": false,
"AutoModeInterval": 3000,
"AutoModeRandomized": false,
"AutoRotation": false,
"Orientation": 1
}
```
`AutoRotation`を`false`に設定し，`Orientation`の値を指定することで表示の向きを固定することができます。
```json
{
"AutoMode": false,
"AutoModeInterval": 3000,
"AutoModeRandomized": false,
"AutoRotation": true
}
```
ランダム切り替え間隔モードをオンにすると，0 ミリ秒から`AutoModeInterval`で指定したミリ秒の間のランダムな間隔で画像を切り替えます。
この設定ファイルは次の「表示する画像のアップロード」の際に画像と一緒に実機のファイルシステムにアップロードされます。
## 表示する画像の準備
### microSDカードの場合
設定ファイル（`image-viewer.json`）と表示する画像ファイル（PNG，JPEG，BMP）をmicroSDカードのルートディレクトリに置きます。使用するmicroSDカードの最大容量は16GBのものを用意し，FAT32でフォーマットしてください。
### LittleFSの場合
設定ファイル（`image-viewer.json`）と表示する画像ファイル（PNG，JPEG，BMP）を`data`ディレクトリに置き，以下のいずれかの方法で実機にアップロードします。
* PlatformIO メニューから「Upload Filesystem Image」を選択する。
* コマンドラインから`pio run --target uploadfs`を実行する。
このとき，設定ファイル`data/image-viewer.json`も含め，`data`ディレイクトリに置かれているファイルはすべて実機にアップロードされます。
## 実行方法
プログラムを起動すると，ファイルシステムにある画像ファイル（PNG，JPEG，BMP）を順に表示します。通常は設定ファイルで指定したモードで起動します。Aボタンを押しながら起動すると，設定にかかわらず自動モードになります。
IMUが使える場合は，画面の向きに合わせて表示が自動的に切り替わります。
起動すると以下の画面が表示されます。設定ファイルがない場合`Config:`の情報は表示されません。
```text
Image Viewer v1.0.6
Config:
/image-viewer.json
AutoMode: false
Interval: 3000ms
Randomized: false
AutoRotation: true
Orientation: CW_0, CW_90, CW_180, CW_270, CCW_0, CCW_90, CCW_180, or CCW_270
Mode:
Manual, Auto, or Auto(Forced)
Rotation:
Auto, No, or No(IMU disabled)
Image Files:
画像ファイル1
画像ファイル2
...
画像ファイルN
```
ファイルシステム上に画像ファイルがない場合は，以下のように表示されます。
```text
Image Viewer v1.0.6
Config:
/image-viewer.json
AutoMode: false
Interval: 3000ms
Randomized: false
AutoRotation: true
Orientation: CW_0, CW_90, CW_180, CW_270, CCW_0, CCW_90, CCW_180, or CCW_270
Mode:
Manual, Auto, or Auto(Forced)
Rotation:
Auto, No, or No(IMU disabled)
No image files found
```
画面に画像一覧が表示されてから一定時間（デフォルトは 3 秒）が経過すると表示モードに応じて画面に画像が表示されます。
## 配布用ファームウェアの作成方法
配布用ファームウェアファイルは以下のいずれかの方法で生成できます。
* PlatformIO メニューから「Custom/Generate User Custom」を選択する。
* コマンドラインから`pio run --target firmware`を実行する。
`firmware`ディレクトリに`[機種名]_[名前]_firmware_[バージョン].bin`ファイルが生成されます。
生成されるファームウェアの設定に関しては，`platformio.ini`ファイルの`image-viewer`セクションにある以下の項目を参照してください。
* 機種名
`custom_firmware_target`
各機種を表す文字列が各環境ごとに定義されています。
例：M5Stack Basic = m5basic
* ファームウェアの名前
`custom_firmware_name`（初期値：`image_viewer`）
* ファームウェアのバージョンが書かれているファイル名
`custom_firmware_version_file` （初期値：`ImageViewer.cpp`）
ソースコードの書かれている`"vX.Y.Z"`から`X.Y.Z`の値を抽出します。
* ファームウェアの拡張子（ドットは不要）
`custom_firmware_suffix`（初期値：`bin`）
* 生成先ディレクトリ
`custom_firmware_dir`（初期値：`firmware`）