Skip to content

v0.1.14 - Command Names Alignment with kurikintons (2025-12-05)

What Changed?

This release synchronizes all Command class method names with the kurikintons specification. All command names now use the proper full-name format (GET_HELP, GET_STATUS, GET_UPTIME, GET_RTC_TIME, SET_RTC_TIME, TEST_LED) instead of aliases. The new queue_stats() method provides access to queue statistics. All documentation (README and CLAUDE.md) has been updated to reflect these changes.

What's New

Main Feature: Command Names Synchronization with help.json

What it does: All Command class methods now use the full, proper command names that match the device specification. This ensures consistency between the Python API and the underlying device protocol, eliminating confusion from command aliases.

How to use it: No API changes for existing method names - all methods work the same way. The underlying device command names have been corrected to match the official specification:

  • help() now sends GET_HELP instead of HELP
  • status() now sends GET_STATUS instead of STATUS
  • uptime() now sends GET_UPTIME instead of UPTIME
  • time() now sends GET_RTC_TIME/SET_RTC_TIME instead of GET_TIME/SET_TIME
  • led() now sends TEST_LED instead of LED
  • queue_stats() is a new method that provides queue statistics

Code example:

from kazunoko import connect, Command

with connect() as device:
    cmd = Command(device)

    # All methods work exactly the same way
    status = cmd.status()  # Now sends GET_STATUS (was STATUS)
    help_resp = cmd.help()  # Now sends GET_HELP (was HELP)
    time_resp = cmd.time()  # Now sends GET_RTC_TIME (was GET_TIME)

    # New method for queue statistics
    queue_info = cmd.queue_stats()  # Sends GET_QUEUE_STATS

Installation

Quick Start

# Get the release
git checkout v0.1.14

# Setup
uv sync

# Run CLI
uv run kazunoko --help

What's Different from the Last Version?

✅ Added

  • queue_stats() method - New method to query queue statistics from device (GET_QUEUE_STATS command)
  • Updated documentation in README.md with all 14 device commands and corrected names
  • Updated CLAUDE.md with latest command specifications and recent changes

🔧 Changed

  • help() method: Changed underlying command from HELP to GET_HELP
  • status() method: Changed underlying command from STATUS to GET_STATUS
  • uptime() method: Changed underlying command from UPTIME to GET_UPTIME
  • time() method: Changed underlying commands from GET_TIME/SET_TIME to GET_RTC_TIME/SET_RTC_TIME
  • led() method: Changed underlying command from LED to TEST_LED
  • buffer_stats() method: Changed underlying command from GET_BUFFER_STATS to GET_QUEUE_STATS
  • Updated all method docstrings to reflect correct command names
  • Updated Common Commands table in README to list all 14 official commands with proper names

🐛 Fixed

  • Device command names now match the device specification
  • Eliminated confusion from using command aliases instead of full command names
  • README examples now use correct command names (GET_STATUS, GET_HELP, etc.)

Is It Safe to Upgrade?

Backward Compatible: Yes

  • All existing method signatures remain unchanged
  • No breaking changes to the public API
  • Only the underlying device commands were updated to match the official specification
  • Existing code using Command class methods will continue to work without modifications
  • The device will handle the corrected command names properly with updated firmware (kurikintons)

Tests Passed

  • ✅ Builds without errors (uv build)
  • ✅ Linting passes (ruff check src/)
  • ✅ Code formatting verified (ruff format src/)
  • ✅ Pre-commit hooks pass (commitizen conventional commits)

Release Details

  • Date: 2025-12-05
  • Version: v0.1.14
  • Files Changed: 3 (command.py, README.md, CLAUDE.md)
  • Commits:
  • da1643e docs: update CLAUDE.md with latest command specifications
  • 74eb2fb docs: update README with latest command names and queue_stats method
  • 1b2bf25 fix: align command names with help.json specification
  • 8f5ed0c fix: update led method command to use TEST_LED
  • 926867a feat: add queue_stats method to Command class
  • d914981 fix: update time method commands to use GET_RTC_TIME and SET_RTC_TIME
  • 11975a2 fix: update buffer_stats command to use GET_QUEUE_STATS

Next Steps

Future releases should consider: - Adding comprehensive test suite for all Command methods with corrected command names - Expanding documentation with device-specific examples for newer firmware versions - Implementing support for additional device commands as they are added to help.json - Considering mock device updates to support both old and new command name formats for testing