Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1.0 #30

Open
14 of 25 tasks
i-n-g-o opened this issue Nov 27, 2023 · 0 comments
Open
14 of 25 tasks

1.0 #30

i-n-g-o opened this issue Nov 27, 2023 · 0 comments
Labels
Milestone

Comments

@i-n-g-o
Copy link
Member

i-n-g-o commented Nov 27, 2023

  • Value Range: do we define that the 2nd value needs to be higher?
    • no
  • Value Color: data example correct? (double-check)
    • change color-value description and added RGB/RGBA Float
  • specify: if a server only sends updates after init is done?
  • parameter tags: Space separated list of tags? 0-terminated list of string-short? or size-prefixed list of string-short
    • limitation by design (tags without spaces)
  • Packet do we need to define the order of timestamp and data?
    • yes
  • specify: Optional properties can be ordered randomly 
    • yes
  • Widget Textbox: does it need a placeholder text? (multilanguage) vs. multilanguage-string for default value?
    • added placeholder in Text Input widget
  • NOTE: Value Enum: make sure indexes are in range and reordering of entries changes value
  • Value URI: specify filter (instead of linking to microsoft)
  • Review Datatypes
  • Re-enumerate Commands?
  • Limit endless parameter id? (e.g.: to 4 bytes) #40
  • Ping/Pong commands? #41
  • consider pre-initizalize command with amount of parameters. this allows a client to show a progress bar until all parameters are transmitted.
  • Is it necessary to forbid parameter id 0? (maybe useful to setup root-group) (Still: a parameter-id of 0 for a parameter is always forbidden)
  • consider all size-prefixes to be dynamic (like parameter id)
  • review all sizes: e.g.: enum-index, order (use unlimited ids?)
  • Review Widgets
  • consider optional-option for parameter #42
  • reconsider MULT-flag in packet to get rid of packet terminator for single-data packets #45
  • rename "Command" to "Packet type"?
  • consider combining readonly, enable into one byte "flags" (parameter, widget)
  • Forward compatibility #46
  • define rcp version and clarify versioning #47
  • Report parsing errors back to server? (servers can escalate an error)
    • Use a error packet? Or use a log packet with log-levels?
  • List-value rework (parsing does not work like it specified right now)
  • Specify Timestamp
  • update kaitai
  • Implementation guidline and version milestones #50
  • Parameter-Id: consider to not decode Rcp-Int (id 0 would be dec 128)
  • Re-introduce number-scale?
@i-n-g-o i-n-g-o added this to the v1.0 milestone Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant