Merge branch 'master-r'

.github/workflows/auto_pr_review.yaml

@@ -33,11 +33,12 @@ jobs:
         already-exists-comment: "Your PR should be made against the `master` branch"
 
     # Welcome comment
-    - name: comment
-      uses: thollander/actions-comment-pull-request@fabd468d3a1a0b97feee5f6b9e499eab0dd903f6
+    - name: "First timers PR"
+      uses: actions/first-interaction@v1
       if: github.event.pull_request.head.repo.full_name != 'commaai/opendbc'
       with:
-        message: |
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        pr-message: |
             <!-- _(run_id **${{ github.run_id }}**)_ -->
             Thanks for contributing to opendbc! In order for us to review your PR as quickly as possible, check the following:
             * Convert your PR to a draft unless it's ready to review
@@ -46,5 +47,3 @@ jobs:
               * the goal is clearly stated in the description
               * all the tests are passing
               * include a route or your device' dongle ID if relevant
-        comment_tag: run_id
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -10,6 +10,7 @@
 .sconsign.dblite
 .hypothesis
 *.egg-info/
+*.html
 uv.lock
 
 opendbc/can/*.so

README.md

@@ -26,3 +26,24 @@ pytest .
 # Run the linter
 pre-commit run --all-files
 ```
+
+[`examples/`](examples/) contains small example programs that can read state from the car and control the steering, gas, and brakes.
+[`examples/joystick.py`](examples/joystick.py) allows you to control a car with a joystick.
+
+## Roadmap
+
+This project was pulled out from [openpilot](https://github.com/commaai/openpilot).
+We're still figuring out the exact API between openpilot and opendbc, so some of these
+may end up going in openpilot.
+
+* Extend support to every car with LKAS + ACC interfaces
+* Automatic lateral and longitudinal control/tuning evaluation
+* Auto-tuning for [lateral](https://blog.comma.ai/090release/#torqued-an-auto-tuner-for-lateral-control) and longitudinal control
+* [Automatic Emergency Braking](https://en.wikipedia.org/wiki/Automated_emergency_braking_system)
+* `pip install opendbc`
+* 100% type coverage
+* 100% line coverage
+* Make car ports easier: refactors, tools, tests, and docs
+* Expose the state of all supported cars better: https://github.com/commaai/opendbc/issues/1144
+
+Contributions towards anything here is welcome. Join the [Discord](https://discord.comma.ai)!

examples/joystick.py

@@ -0,0 +1,113 @@
+#!/usr/bin/env python3
+import time
+import threading
+import argparse
+import numpy as np
+from pprint import pprint
+from inputs import get_gamepad
+
+from kbhit import KBHit
+
+from opendbc.car.structs import CarControl
+from opendbc.car.panda_runner import PandaRunner
+
+class Keyboard:
+  def __init__(self):
+    self.kb = KBHit()
+    self.axis_increment = 0.05  # 5% of full actuation each key press
+    self.axes_map = {'w': 'gb', 's': 'gb',
+                     'a': 'steer', 'd': 'steer'}
+    self.axes_values = {'gb': 0., 'steer': 0.}
+    self.axes_order = ['gb', 'steer']
+    self.cancel = False
+
+  def update(self):
+    key = self.kb.getch().lower()
+    print(key)
+    self.cancel = False
+    if key == 'r':
+      self.axes_values = {ax: 0. for ax in self.axes_values}
+    elif key == 'c':
+      self.cancel = True
+    elif key in self.axes_map:
+      axis = self.axes_map[key]
+      incr = self.axis_increment if key in ['w', 'a'] else -self.axis_increment
+      self.axes_values[axis] = float(np.clip(self.axes_values[axis] + incr, -1, 1))
+    else:
+      return False
+    return True
+
+class Joystick:
+  def __init__(self, gamepad=False):
+    # TODO: find a way to get this from API, perhaps "inputs" doesn't support it
+    if gamepad:
+      self.cancel_button = 'BTN_NORTH'  # (BTN_NORTH=X, ABS_RZ=Right Trigger)
+      accel_axis = 'ABS_Y'
+      steer_axis = 'ABS_RX'
+    else:
+      self.cancel_button = 'BTN_TRIGGER'
+      accel_axis = 'ABS_Y'
+      steer_axis = 'ABS_RX'
+    self.min_axis_value = {accel_axis: 0., steer_axis: 0.}
+    self.max_axis_value = {accel_axis: 255., steer_axis: 255.}
+    self.axes_values = {accel_axis: 0., steer_axis: 0.}
+    self.axes_order = [accel_axis, steer_axis]
+    self.cancel = False
+
+  def update(self):
+    joystick_event = get_gamepad()[0]
+    event = (joystick_event.code, joystick_event.state)
+    if event[0] == self.cancel_button:
+      if event[1] == 1:
+        self.cancel = True
+      elif event[1] == 0:   # state 0 is falling edge
+        self.cancel = False
+    elif event[0] in self.axes_values:
+      self.max_axis_value[event[0]] = max(event[1], self.max_axis_value[event[0]])
+      self.min_axis_value[event[0]] = min(event[1], self.min_axis_value[event[0]])
+
+      norm = -float(np.interp(event[1], [self.min_axis_value[event[0]], self.max_axis_value[event[0]]], [-1., 1.]))
+      self.axes_values[event[0]] = norm if abs(norm) > 0.05 else 0.  # center can be noisy, deadzone of 5%
+    else:
+      return False
+    return True
+
+def joystick_thread(joystick):
+  while True:
+    joystick.update()
+
+def main(joystick):
+  threading.Thread(target=joystick_thread, args=(joystick,), daemon=True).start()
+  with PandaRunner() as p:
+    CC = CarControl(enabled=False)
+    while True:
+      CC.actuators.accel = float(4.0*np.clip(joystick.axes_values['gb'], -1, 1))
+      CC.actuators.steer = float(np.clip(joystick.axes_values['steer'], -1, 1))
+      pprint(CC)
+
+      p.read()
+      p.write(CC)
+
+      # 100Hz
+      time.sleep(0.01)
+
+
+if __name__ == '__main__':
+  parser = argparse.ArgumentParser(description='Test the car interface with a joystick. Uses keyboard by default.',
+                                   formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+
+  parser.add_argument('--mode', choices=['keyboard', 'gamepad', 'joystick'], default='keyboard')
+  args = parser.parse_args()
+
+  print()
+  joystick: Keyboard | Joystick
+  if args.mode == 'keyboard':
+    print('Gas/brake control: `W` and `S` keys')
+    print('Steering control: `A` and `D` keys')
+    print('Buttons')
+    print('- `R`: Resets axes')
+    print('- `C`: Cancel cruise control')
+    joystick = Keyboard()
+  else:
+    joystick = Joystick(gamepad=(args.mode == 'gamepad'))
+  main(joystick)

examples/kbhit.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env python3
+import sys
+import termios
+import atexit
+from select import select
+
+STDIN_FD = sys.stdin.fileno()
+
+class KBHit:
+  def __init__(self) -> None:
+    self.set_kbhit_terminal()
+
+  def set_kbhit_terminal(self) -> None:
+    # Save the terminal settings
+    self.old_term = termios.tcgetattr(STDIN_FD)
+    self.new_term = self.old_term.copy()
+
+    # New terminal setting unbuffered
+    self.new_term[3] &= ~(termios.ICANON | termios.ECHO)
+    termios.tcsetattr(STDIN_FD, termios.TCSAFLUSH, self.new_term)
+
+    # Support normal-terminal reset at exit
+    atexit.register(self.set_normal_term)
+
+  def set_normal_term(self) -> None:
+    termios.tcsetattr(STDIN_FD, termios.TCSAFLUSH, self.old_term)
+
+  @staticmethod
+  def getch() -> str:
+    return sys.stdin.read(1)
+
+  @staticmethod
+  def getarrow() -> int:
+    c = sys.stdin.read(3)[2]
+    vals = [65, 67, 66, 68]
+    return vals.index(ord(c))
+
+  @staticmethod
+  def kbhit():
+    ''' Returns True if keyboard character was hit, False otherwise.
+    '''
+    return select([sys.stdin], [], [], 0)[0] != []
+
+
+if __name__ == "__main__":
+
+  kb = KBHit()
+
+  print('Hit any key, or ESC to exit')
+
+  while True:
+
+    if kb.kbhit():
+      c = kb.getch()
+      if c == '\x1b':  # ESC
+        break
+      print(c)
+
+  kb.set_normal_term()