[Julusian]

Document the satellite API 1.16.0 changes from bitfocus/companion#4534 and bitfocus/companion@aa29879d2.

Bitmap caching: BITMAP_CACHE in CAPS, the BITMAP-CACHE and BITMAP-COST messages, BITMAP-EVICT, and BITMAP_ID on KEY-STATE and SUB-STATE. The main protocol sections only point at the new section, so a client can be built without caching first and have it added afterwards.

JSON variable values: ENCODING on SET-VARIABLE-VALUE and VARIABLE-VALUE, and VARIABLE_ENCODING on ADD-DEVICE to opt in to receiving JSON values.

🤖 Generated with Claude Code

[coderabbitai]

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 11 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: 3f7b8342-2ecc-45a0-888f-ee35baa64e15

Commits

Reviewing files that changed from the base of the PR and between 627d9e6 and d1fb9da.

Files selected for processing: 1

• for-developers/Satellite-API.md

Walkthrough

The Satellite API documentation adds API version 1.16 support and describes the opt-in bitmap cache protocol, including state updates, budget controls, cost reports, eviction messages, and client handling rules.

Changes: Satellite API bitmap cache

Layer / File(s)	Summary
Version, capability, and state update contract for-developers/Satellite-API.md	Documents API version 1.16, the BITMAP_CACHE capability, and BITMAP_ID in key and subscription state updates. It also describes cache scope, client storage rules, and the byte budget.
Budget, cost, eviction, and state messages for-developers/Satellite-API.md	Documents BITMAP-CACHE, BITMAP-COST, and BITMAP-EVICT, cached state update forms, a protocol example, and budget guidance.

Priority: Low

Merge Risk: Low · previous review 627d9

Clarify that bitmap IDs are reusable only while cached to prevent client interoperability errors.

Pre-merge checks: 4

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Title check		The title clearly identifies the documentation update for Satellite API 1.16.0 and bitmap caching, which is the main change. The reference to JSON variable values is not reflected in the provided chan…

Full details: Title check

Explanation

The title clearly identifies the documentation update for Satellite API 1.16.0 and bitmap caching, which is the main change. The reference to JSON variable values is not reflected in the provided change summary, but the title remains substantially related to the pull request.

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{A budget opens up the store
IDs arrive beside the pixels
Oldest entries leave on cue
Clients keep each message’s order
Costs help Companion count
Cache rests when the budget’s zero}

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

---

Review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: Organization UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: 840a5ae4-72f9-4505-a1a6-b4d9bc3cfb80

Commits

Reviewing files that changed from the base of the PR and between df6de07 and 627d9e6.

Files selected for processing: 1

• for-developers/Satellite-API.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.