Repository navigation
Document what E1.31 behaviour is left to the application - #87
Open
stewartadam wants to merge 1 commit into
Open
stewartadam wants to merge 1 commit into
stewartadam wants to merge 1 commit into
Conversation
SacnSource only transmits when send is called, and SacnReceiver passes unsynchronised data up per source without arbitrating by priority. Say so in the README, with what the standard expects (Sections 6.6 and 6.2.3) and the hooks the library provides. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KzaQVQThQpmqhvLapk99Vs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two E1.31-2016 behaviours depend on how the library is used, and the library leaves them to the caller. The compliance checklist in
documentation/already marks both as the user's job. This PR states that in the README so users don't assume the library handles them.SacnSourceonly transmits whensendis called. The new section gives the refresh rate cap, the three repeats when data stops changing, the 800–1000 ms keep-alive interval, and the 2.5 s data loss timeout that receivers apply.SacnReceiver::recvpasses up unsynchronised data per source, with its priority and CID. The new section explains that arbitration and merging are the caller's job, and points tohtp_dmx_mergeandset_merge_fn.Documentation only. There are no code changes.