BSD-3-Clause licensed and maintained by Andreas Ländle
This version can be pinned in stack with:wled-json-0.0.1.0@sha256:2906e23c7d1adff790312bdda16310e07715d6c94a8f563922104b9caf3c72a4,2501

Module documentation for 0.0.1.0

wled-json ✨

Haskell bindings for controlling WLED devices, with a focus on Octolamps

Introduction 💡

This Haskell library provides a convenient interface for interacting with WLED devices, particularly those based on the popular Octolamp design. It leverages the WLED API (https://kno.wled.ge/) to allow you to control various aspects of your LED lights, including:

  • Color: Set the color of your lights using various color spaces (RGB, HSV, etc.)
  • Brightness: Adjust the overall brightness of your lights

Installation ⚙️

# Using cabal
cabal add wled-json

# Using stack
stack add wled-json

Usage 📲

import           Control.Concurrent
import           WLED.Device
import           WLED.Octocat.Flags (france)
import           WLED.Types

main :: IO ()
main = do
    -- Connect to a WLED device
    lampState <- getLampState wledUrl
    case lampState of
        Left errMsg -> putStrLn errMsg
        Right initialState -> do
            -- Display the French flag on an Octolamp
            _ <- setLampState wledUrl france

            -- Just sleep one second
            threadDelay 1000000
            
            -- Restore the initial state
            Right currentState <- getLampState wledUrl
            _ <- setLampState wledUrl (diff currentState initialState)
            pure ()
  where
    wledUrl = "http://192.168.178.34"

Features 👍

  • Comprehensive WLED API coverage
  • Type-safe interactions
  • Easy-to-use API
  • Specific support for Octolamps

Contributing 🤝

Contributions are welcome! Please feel free to open an issue or submit a pull request.

License ✌️

BSD-3-Clause

Changes

Changelog for wled-json

Hopefully all notable changes to this project will be documented in this file.

The project adheres to the Haskell Package Versioning Policy.

Unreleased

0.0.1.0 - Initial release - 2024-12-02

  • Core Functionality:
    • Basic connection to WLED devices
    • Setting color, brightness, etc.
  • Octolamp Support:
    • Initial support for Octolamp-specific features (provide the French flag)