Interactive-CZ-Map

This project is a firmware for the LaskaKit Interactive CZ Map. It is designed to be controlled from AWS IoT Core. The map uses WS2812B LEDs to display various interactive features and information.

The project was created in PlatformIO 22.11.2024

Configuration and build

1. Ensure you have the PlatformIO extension installed in VS Code.
2. Create a copy of src/secrets.h.example and rename it to src/secrets.h.
3. Customize values in src/secrets.h to match your AWS IoT Core configuration and update WiFi configuration if needed. Use this guide to create a new thing in AWS IoT Core and get the required values.
4. Use PlatformIO to build and upload the project to your ESP device.
5. Default password for AP mode is 12345678.

Testing

You can send messages to the device in AWS IoT MQTT Test console. See test folder for examples.

Commands

All commands are sent to the device using MQTT. Commands could be sent as general messages or personalized for a specific device by Client ID. The device subscribes to the following topics:

• int-cz-map/cmd/leds/#
• int-cz-map/cmd/update/#

Example of LEDs command

Topic general: int-cz-map/cmd/leds Topic personalized: int-cz-map/cmd/leds/AABBCC

Single sequence for single LED

{
    "leds": [
        {
            "id": 1,
            "cl": "FFFFFF",
            "br": 100,
            "dr": 600,
            "ct": 2
        }
    ]
}

Multiple sequences for single LED

{
    "leds": [
        {
            "id": 36,
            "cl": "FF0000",
            "br": 50,
            "dr": 600,
            "ct": 2
        },
        {
            "id": 36,
            "cl": "00FF00",
            "br": 100,
            "dr": 300,
            "ct": 2
        },
        {
            "id": 36,
            "cl": "0000FF",
            "ct": 5
        }
    ]
}

Single sequence for multiple LEDs

{
    "leds": [
        {
            "id": 1,
            "cl": "00FFFF",
            "br": 100,
            "dr": 600,
            "ct": 2
        },
        {
            "id": 2,
            "cl": "FF0000",
            "br": 50,
            "dr": 300,
            "ct": 2
        },
        {
            "id": 3,
            "cl": "00FF00",
            "br": 100,
            "dr": 600,
            "ct": 2
        },
        {
            "id": 4,
            "cl": "FF00FF",
            "br": 50,
            "dr": 300,
            "ct": 2
        }
    ]
}

Example of FW Update command

Topic general: int-cz-map/cmd/update Topic personalized: int-cz-map/cmd/update/AABBCC

{
    "firmware_url": "https://example.com/firmware.bin"
}

Dependencies

All dependencies could be found in platformio.ini file under lib_deps section.

Copyright

Copyright (c) 2024 Sen Morgan. Licensed under the MIT license, see LICENSE.md