Skip to content

CLAUDE.md

Latest commit

 

History

History
54 lines (39 loc) · 1.97 KB

CLAUDE.md

File metadata and controls

54 lines (39 loc) · 1.97 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

A device library for IoT device definitions used by the ENEROOO Spark platform, with a Django web application for managing the library. The database is the source of truth; YAML export is available for backup/sync.

Repository Structure

  • src/ - Django web application for library management

Device Schema (v2)

Each device definition follows this structure:

device_types:
- vendor_name: string
  model_number: string
  name: string
  device_type: power_meter | gateway | environment_sensor | water_meter | heat_meter
  description: string (optional)
  technology_config:
    technology: modbus | lorawan | wmbus
    # technology-specific fields below
  control_config: # optional
    capabilities: {}
    controllable: boolean
  processor_config: # optional
    decoder_type: string

Technology-Specific Fields

Modbus (technology_config):

  • register_definitions[] - Each with: field (name, unit), scale, offset, address, data_type (int16, uint16, int32, uint32, float32)

LoRaWAN (technology_config):

  • device_class (A/B/C), downlink_f_port, plus optional control_config.capabilities for relay commands

wM-Bus (technology_config):

  • manufacturer_code, wmbus_version (hex byte, e.g. "1b"), wmbus_device_type (numeric), data_record_mapping[], encryption_required, optional shared_encryption_key

Conventions

  • Conventional commits with these patterns:
    • chore(library): add/update [vendor] device types - device changes
    • chore(manifest): bump to X.X.X - version bumps (separate commit)
    • fix(<vendor>): <description> - vendor-specific fixes (scope is lowercase vendor name)
    • feat(tools): <description> - web application changes
  • Keep device entries alphabetically ordered within files when practical
  • PR-based workflow: changes go through pull requests, not direct pushes