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

Create standard list of keys #1

Open
katzuv opened this issue Nov 4, 2022 · 1 comment
Open

Create standard list of keys #1

katzuv opened this issue Nov 4, 2022 · 1 comment
Assignees
Labels

Comments

@katzuv
Copy link
Member

katzuv commented Nov 4, 2022

No description provided.

@katzuv katzuv added the Logging label Nov 4, 2022
@katzuv katzuv self-assigned this Nov 4, 2022
@katzuv
Copy link
Member Author

katzuv commented Nov 12, 2022

Keys are divided into general keys and subsystem-specific keys. All keys start with \.

General keys: \robot

  • odometry
    • \pose:
      • double[] of three values: x, y, heading.
      • Units: x and y are in [m], heading is in [°]
      • Example: \robot\odometry\pose ➡️ [1.23, 4.56, 7.89]
    • \velocity: double[] of three values: x, y, rotational
  • \commands: logs string messages of command start/stop
    • Message structure [JSON]:
      • Start: {"subsystem": $subsytem_name, "state": "start", "parameters": {$argument1: $paramater1, $argument2: $paramater2, ...}
      • End: {"subsystem": $subsytem_name, "state": "end", "interrupted": true/false}
  • vision
    • distance: double
    • yaw: double
    • pitch: double
    • roll: double
    • has_target: boolean
    • apriltags: TBP from PhotonVision

    Subsystem-specific: \subsystems\{subsystem}

  • per {motor_name}
    • velocity
      • raw sensor units, example: \subsystems\elevator\main\velocity\raw
      • human readable units, e.g. m, m/s, °
    • position: raw and human as abovementioned
    • velocity: raw and human as abovementioned

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