This is a module for MagicMirror² that displays data from your YoLink sensors. After a truly epic journey of trial, error, and some fantastic community-led detective work, it finally works! My entire purpose for this was so that I could see a hot tub if it went into an error state.

This module was built through sheer persistence and the goodwill of the open-source community. It works for me, and I hope it works for you! However, please consider it a "use at your own risk" project. I can't offer official support, but I'll do my best to help if I can.

Getting this module up and running is pretty straightforward.

1. Navigate to your modules folder: Open a terminal on your Raspberry Pi and go to your MagicMirror modules directory.

   cd ~/MagicMirror/modules

2. Clone the repository:

   git clone https://github.com/LindsayCole/MMM-YoLink.git

3. Install dependencies: This module needs node-fetch to talk to the YoLink servers.

   cd MMM-YoLink
   npm install

That's it for the installation! Now, let's get it configured.

Before you can configure the module, you need to get your personal API credentials from the YoLink app.

1. Open the YoLink app on your mobile device.
2. Tap the menu icon (☰) in the top-left corner.
3. Go to Settings.
4. Tap on User Access Credentials.
5. You will find your UAID (which you'll use for uaid) and Secret Key (for secretKey) on this screen.

Add the module to your ~/MagicMirror/config/config.js file. Here is a sample configuration with all the available options explained.

{
    module: "MMM-YoLink",
    position: "top_left", // Or wherever you want it!
    // header: "YoLink Sensors", // This line is commented out to hide the header
    config: {
        // --- Required ---
        uaid: "your_uaid_from_the_app",
        secretKey: "your_secretKey_from_the_app",

        // --- Layout & Alerts ---
        staticDeviceId: null, // Set a device ID here to make it always visible on the left.
        rotationInterval: 10 * 1000, // How often to rotate the other sensors (in ms).
        hotTubDeviceId: null, // Set the ID of a temperature sensor to monitor for alerts.
        hotTubTempDrop: 5, // Degrees C or F to trigger the flashing alert.

        // --- Filtering ---
        deviceIds: [], // Leave empty to show all compatible devices.
        showTypes: ["THSensor", "LeakSensor", "DoorSensor", "MotionSensor"],
        excludeIds: [],

        // --- Customization ---
        tempUnit: "C", // "C" for Celsius, "F" for Fahrenheit
        batteryThreshold: 25, // Show battery level only if it's at or below this percentage.
        updateInterval: 5 * 60 * 1000,
        deviceColors: {
            "d88b4c040005efe3": "#f5a623", // Example: Set a custom color for a specific device
            "another_device_id": "lightblue"
        }
    }
},

Enjoy your new sensor display!