lifxregistry-go

module
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: Oct 8, 2026 License: MIT

README

lifxregistry-go

This repository provides a Go-based generator for the LIFX product registry, producing Go types and definitions for use in applications that discover or interact with known LIFX device models.

It includes:

  • cmd/registry-gen — the generator tool for the LIFX product registry.
  • cmd/registry-gen/src/registry.json — the upstream products registry definition from the official LIFX products repo.
  • cmd/registry-gen/src/registry_commit.txt — the upstream commit the current definition was sourced from.
  • cmd/registry-gen/gen/ — generated Go files containing typed device metadata.

Usage

To update and regenerate the LIFX registry Go code:

make regenerate

This will:

  • Clone the latest upstream LIFX/products repo.
  • Check if the products commit has changed.
  • If changed, copy the new products.json and commit hash.
  • Regenerate Go code under gen/.

To regenerate from the already checked-in registry (for example after changing the generator), run go run ./cmd/registry-gen directly. make regenerate currently skips generation if the upstream registry commit has not changed.

Generated FeatureSet.UplightCoords is an optional *UplightCoordinates with X and Y integer fields and the JSON key uplight_coords. Missing or null metadata is nil and omitted from JSON and generated literals; a valid (0,0) remains non-nil. Coordinates are carried through both base product features and firmware upgrades without interpreting their device-specific physical mapping.

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
registry-gen command
gen
registry
Code generated.
Code generated.

Jump to

Keyboard shortcuts

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