lifxprotocol-go

module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 16, 2025 License: MIT

README

lifxprotocol-go

This repository provides the LIFX LAN protocol definitions and a Go-based code generator for working with LIFX devices on the local network.

It includes:

  • cmd/protocol-gen — a code generator that produces Go types and packet structures.
  • cmd/protocol-gen/src/protocol.yml — the upstream protocol definition from the official LIFX repo.
  • cmd/protocol-gen/src/protocol_commit.txt — the upstream commit the current protocol definition was sourced from.
  • gen/ — the generated Go files ready to be imported by other projects.

Usage

To update the protocol and regenerate code:

make regenerate

This will:

  • Clone the latest upstream lifx-protocol repo.
  • Check if the protocol definition has changed.
  • If changed, copy the new protocol.yml and commit hash.
  • Regenerate Go code under gen/.
Requirements
  • Go 1.24+
  • Git
  • Internet connection (to fetch latest upstream repo)
License

This project is MIT licensed. See LICENSE for details.

Directories

Path Synopsis
cmd
protocol-gen command
gen
protocol/enums
Code generated.
Code generated.
protocol/packets
Code generated.
Code generated.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL