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

Consistent Command Structure Proposal #306

Open
pmantoine opened this issue Feb 16, 2023 · 1 comment
Open

Consistent Command Structure Proposal #306

pmantoine opened this issue Feb 16, 2023 · 1 comment
Assignees
Labels
Enhancement New feature or request EX-CommandStation Item relates to the core EX-CommandStation code

Comments

@pmantoine
Copy link
Contributor

Peter (flash62au) has some possible rules for a new command structure:

  1. Uppercase commands. Lowercase responses (echo)
  2. most commands would have two parts. a) what type of 'thing' you are acting on. b) the action or nature of the respose. e.g. <P 1 = Power on <P 1 1 =Power On Track 1
  3. the first letter have a clear, unique meaning. e.g. T,t = turnout L,l=loco or E,e=engine P,p =power
  4. if a response first letter has more than one meaning then the second letter (or second parameter) will be distinctly different e.g <T A = Throttle,Action <T L = Throttle list request <t L = Throttle list response <t E = Throttle Entry respone etc.
  5. a response (type) will always have the same number of parameters e.g. <t E id "desc" = valid or <t E id X = unkown
  6. etc.
@github-actions github-actions bot added the EX-CommandStation Item relates to the core EX-CommandStation code label Feb 16, 2023
@pmantoine pmantoine added the Enhancement New feature or request label Feb 16, 2023
@Asbelos
Copy link
Contributor

Asbelos commented Feb 16, 2023

Do not use <> as command delimiters to avoid all confusion and ambiguity of previous protocol.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request EX-CommandStation Item relates to the core EX-CommandStation code
Projects
Status: Backlog
Development

No branches or pull requests

3 participants