Skip to content

Latest commit

 

History

History
180 lines (141 loc) · 7.3 KB

README_en_US.md

File metadata and controls

180 lines (141 loc) · 7.3 KB
Raw

Image Viewer for M5Stack Series

This program displays images stored on the LittleFS file system or SD card of the M5Stack series devices one after another.

There are two display modes available:

  • Manual Mode
    Press the A button to switch and display images one by one.
  • Auto Mode
    Displays images at intervals (in milliseconds) specified in the configuration file. It can also display images at random intervals up to the specified display interval.

How to Compile

Compile in the PlatformIO IDE environment. Please select the environment appropriate for your model. Environments with '-sd' prefix are for devices with an microSD card slot.

Model Environment
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 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)

The default display orientation is different for each model.

Model Environment Default Orientation
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

Configuration File

The following settings can be configured in the data/image-viewer.json configuration file:

  • AutoMode
    Turn auto display mode on (true) or off (false).
  • AutoModeInterval
    Interval for switching images in auto display mode (milliseconds).
  • AutoModeRandomized
    Turn random interval switching mode on (true) or off (false).
  • AutoRotation Turn automatically adjusting the display orientation on (true) or off (false) for IMU included devices.
  • Orientation
    Display Orientation(this value is passed to M5GFX::setRotation())

If the configuration file is missing, auto mode is off (false), the switch interval is 3 seconds (3000 milliseconds), and random interval switching mode is off (false), the display orientation is set to the default orientation of the model.

{
  "AutoMode": false,
  "AutoModeInterval": 3000,
  "AutoModeRandomized": false,
  "AutoRotation": false,
  "Orientation": 1
}

By setting AutoRotation to false and specifying the value for Orientation, you can fix the display orientation.

{
  "AutoMode": false,
  "AutoModeInterval": 3000,
  "AutoModeRandomized": false,
  "AutoRotation": true
}

Turning on the random interval switching mode will switch images at random intervals between 0 milliseconds and the interval specified by AutoModeInterval.

This configuration file will be uploaded to the device's file system along with the images during the "Uploading Images to Display" process in the next step.

Uploading Images to Display

For microSD Card

Place the configuration file (image-viewer.json) and the image files you want to display (PNG, JPEG, BMP) in the root directory of the microSD card. Prepare a microSD card with a maximum capacity of 16GB and format it as FAT32.

For LittleFS

Place image files (PNG, JPEG, BMP) in the data directory and upload them to the device using one of the following methods:

  • Select "Upload Filesystem Image" from the PlatformIO menu.
  • Execute pio run --target uploadfs from the command line.

All files placed in the data directory, including the data/image-viewer.json configuration file, will be uploaded to the device.

How to Run

When the program is launched, it sequentially displays image files (PNG, JPEG, BMP) found in the file system. Normally, it starts in the mode specified in the configuration file. If the A button is pressed while starting, it switches to auto mode regardless of the settings.

If an IMU is available on your device, the display orientation automatically changes to match the screen's orientation.

Upon startup, the following is displayed. If there is no configuration file, the Config: information will not be shown.

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:
 Image File 1
 Image File 2
 ...
 Image File N

If no image files are found on the file system, the following message is displayed:

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

After displaying the list of images for a certain period (default is 3 seconds), the screen displays images according to the selected mode.

How to Create Custom Firmware

To generate a custom firmware file for distribution, you can use either of the following methods:

  • Select "Custom/Generate User Custom" from the PlatformIO menu.
  • Execute pio run --target firmware from the command line.

A file named [model_name]_image_viewer_firmware_[version].bin will be generated in the firmware directory.

For settings related to the firmware being generated, please refer to the following items in the image-viewer section of the platformio.ini file:

  • Model name
    custom_firmware_target
    A string representing each model is defined for each environment.
    Example: M5Stack Basic = m5basic
  • Firmware name
    custom_firmware_name (Default: image_viewer)
  • File name containing the firmware version
    custom_firmware_version_file (Default: ImageViewer.cpp)
    Extracts the value of X.Y.Z from the code written as "vX.Y.Z".
  • Firmware extension (dot not required)
    custom_firmware_suffix (Default: bin)
  • Destination directory
    custom_firmware_dir (Default: firmware)