Merge pull request #660 from commaai/devel

Openpilot 0.5.12

.dockerignore

@@ -1,18 +0,0 @@
-**/.git
-.DS_Store
-*.dylib
-*.DSYM
-*.d
-*.pyc
-*.pyo
-.*.swp
-.*.swo
-.*.un~
-*.tmp
-*.o
-*.o-*
-*.os
-*.os-*
-
-venv/
-.venv/

.editorconfig

@@ -1,11 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.{py,pyx,pxd}]
-charset = utf-8
-indent_style = space
-indent_size = 2

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,47 +0,0 @@
-name: Bug report
-description: For issues with running openpilot on your comma device
-labels: ["bug"]
-body:
-
-  - type: markdown
-    attributes:
-      value: >
-        Before creating a **bug report**, please check the following:
-          * If the issue likely only affects your car model or make, go back and open a **car bug report** instead.
-          * If the issue is related to the driving or driver monitoring models, you should open a [discussion](https://github.com/commaai/openpilot/discussions/categories/model-feedback) instead.
-          * Ensure you're running the latest openpilot release.
-          * Ensure you're using officially supported hardware. Issues running on PCs have a different issue template.
-          * Ensure there isn't an existing issue for your bug. If there is, leave a comment on the existing issue.
-          * Ensure you're running stock openpilot. We cannot look into bug reports from forks.
-
-        If you're unsure whether you've hit a bug, check out the #installation-help channel in the [community Discord server](https://discord.comma.ai).
-
-  - type: textarea
-    attributes:
-      label: Describe the bug
-      description: Also include a description of how to reproduce the bug
-    validations:
-      required: true
-
-  - type: input
-    id: route
-    attributes:
-      label: Provide a route where the issue occurs
-      description: Ensure the route is fully uploaded at https://useradmin.comma.ai. We cannot look into issues without routes, or at least a Dongle ID.
-      placeholder: 77611a1fac303767|2020-05-11--16-37-07
-    validations:
-      required: true
-
-  - type: input
-    id: version
-    attributes:
-      label: openpilot version
-      description: If you're not on release, provide the commit hash
-      placeholder: 0.8.10
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Additional info
-

.github/ISSUE_TEMPLATE/config.yml

@@ -1,14 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Car bug report
-    url: https://github.com/commaai/opendbc/issues/new
-    about: For issues with a particular car make or model
-  - name: Join the Discord
-    url: https://discord.comma.ai
-    about: The community Discord is for both openpilot development and experience discussion
-  - name: Report driving behavior feedback
-    url: https://discord.com/channels/469524606043160576/1254834193066623017
-    about: Feedback for the driving and driver monitoring models goes in the #driving-feedback in Discord
-  - name: Community Wiki
-    url: https://github.com/commaai/openpilot/wiki
-    about: Check out our community wiki

.github/ISSUE_TEMPLATE/enhancement.md

@@ -1,8 +0,0 @@
----
-name: Enhancement
-about: For openpilot enhancement suggestions
-title: ''
-labels: 'enhancement'
-assignees: ''
----
-

.github/ISSUE_TEMPLATE/pc_bug_report.yml

@@ -1,42 +0,0 @@
-name: PC bug report
-description: For issues with running openpilot on PC
-labels: ["PC"]
-body:
-
-  - type: markdown
-    attributes:
-      value: >
-        Before creating a **bug report**, please check the following:
-          * Ensure you're running the latest openpilot release.
-          * Ensure there isn't an existing issue for your bug. If there is, leave a comment on the existing issue.
-          * Ensure you're running stock openpilot. We cannot look into bug reports from forks.
-
-        If you're unsure whether you've hit a bug, check out the #installation-help channel in the [community Discord server](https://discord.comma.ai).
-
-  - type: textarea
-    attributes:
-      label: Describe the bug
-      description: Also include a description of how to reproduce the bug
-    validations:
-      required: true
-
-  - type: input
-    id: os-version
-    attributes:
-      label: OS Version
-      placeholder: Ubuntu 24.04
-    validations:
-      required: true
-
-  - type: input
-    id: version
-    attributes:
-      label: openpilot version or commit
-      placeholder: bd36f2ec8d3559909678eff2690c10a520938367
-    validations:
-      required: false
-
-  - type: textarea
-    attributes:
-      label: Additional info
-

.github/labeler.yaml

@@ -1,27 +0,0 @@
-CI / testing:
-  - changed-files:
-    - any-glob-to-all-files: "{.github/**,**/test_*,**/test/**,Jenkinsfile}"
-
-car:
-  - changed-files:
-    - any-glob-to-all-files: '{selfdrive/car/**,opendbc_repo}'
-
-simulation:
-  - changed-files:
-    - any-glob-to-all-files: 'tools/sim/**'
-
-ui:
-  - changed-files:
-    - any-glob-to-all-files: '{selfdrive/assets/**,selfdrive/ui/**,system/ui/**}'
-
-tools:
-  - changed-files:
-    - any-glob-to-all-files: 'tools/**'
-
-multilanguage:
-  - changed-files:
-    - any-glob-to-all-files: 'selfdrive/ui/translations/**'
-
-autonomy:
-  - changed-files:
-    - any-glob-to-all-files: "{selfdrive/modeld/models/**,selfdrive/test/process_replay/model_replay_ref_commit}"

.github/pull_request_template.md

@@ -1,68 +0,0 @@
-<!-- Please copy and paste the relevant template -->
-
-<!--- ***** Template: Fingerprint *****
-
-**Car**
-Which car (make, model, year) this fingerprint is for
-
-**Route**
-A route with the fingerprint
-
--->
-
-<!--- ***** Template: Car Bugfix *****
-
-**Description**
-
-A description of the bug and the fix. Also link the issue if it exists. 
-
-**Verification**
-
-Explain how you tested this bug fix. 
-
-**Route**
-
-Route: [a route with the bug fix]
-
-
--->
-
-<!--- ***** Template: Bugfix *****
-
-**Description**
-
-A description of the bug and the fix. Also link the issue if it exists. 
-
-**Verification**
-
-Explain how you tested this bug fix. 
-
-
--->
-
-<!--- ***** Template: Car Port *****
-
-**Checklist**
-
-- [ ] added entry to CAR in selfdrive/car/*/values.py and ran `selfdrive/car/docs.py` to generate new docs
-- [ ] test route added to [routes.py](https://github.com/commaai/openpilot/blob/master/selfdrive/car/tests/routes.py)
-- [ ] route with openpilot:
-- [ ] route with stock system:
-- [ ] car harness used (if comma doesn't sell it, put N/A):
-
-
--->
-
-<!--- ***** Template: Refactor *****
-
-**Description**
-
-A description of the refactor, including the goals it accomplishes. 
-
-**Verification**
-
-Explain how you tested the refactor for regressions. 
-
-
--->
-

.gitignore

@@ -1,91 +1,36 @@
-venv/
-.venv/
-.ci_cache
-.env
-.clang-format
 .DS_Store
 .tags
 .ipynb_checkpoints
 .idea
-.overlay_init
-.overlay_consistent
 .sconsign.dblite
+model2.png
 a.out
-.hypothesis
-.cache/
-bin/
 
-*.mp4
-*.dylib
 *.DSYM
 *.d
-*.pem
 *.pyc
 *.pyo
 .*.swp
 .*.swo
 .*.un~
-*.tmp
 *.o
-*.o-*
-*.os
-*.os-*
 *.so
 *.a
 *.clb
 *.class
 *.pyxbldc
 *.vcd
-*.mo
-*_pyx.cpp
-*.stats
-*.pkl
-*.pkl*
 config.json
-compile_commands.json
-compare_runtime*.html
+clcache
 
-# build artifacts
-selfdrive/pandad/pandad
-cereal/services.h
-cereal/gen
-cereal/messaging/bridge
-selfdrive/ui/translations/tmp
-selfdrive/car/tests/cars_dump
-system/camerad/camerad
-system/camerad/test/ae_gray_test
+board/obj/
+selfdrive/boardd/boardd
+selfdrive/logcatd/logcatd
+selfdrive/mapd/default_speeds_by_region.json
+selfdrive/proclogd/proclogd
+selfdrive/ui/ui
+selfdrive/test/tests/plant/out
+selfdrive/visiond/visiond
+/src/
 
-.coverage*
-coverage.xml
-htmlcov
-
-# openpilot log files
-*.bz2
-*.zst
-*.rlog
-
-build/
-
-!**/.gitkeep
-
-
-### VisualStudioCode ###
-*.vsix
-.history
-.ionide
-.vscode/*
-.history/
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-!.vscode/*.code-snippets
-
-# agents
-.claude/
-.context/
-PLAN.md
-TASK.md
-
-# rick - keep panda_tici standalone
-panda_tici/
+one

.pylintrc

@@ -3,11 +3,11 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code
-extension-pkg-whitelist=scipy,cereal.messaging.messaging_pyx,PyQt5,av
+extension-pkg-whitelist=scipy
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
-ignore=CVS,autogen,msm_kgsl.py,runtime,.venv
+ignore=CVS
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
@@ -30,6 +30,10 @@ persistent=yes
 # Specify a configuration file.
 #rcfile=
 
+# When enabled, pylint would attempt to guess common misconfiguration and emit
+# user-friendly hints instead of false-positive error messages
+suggestion-mode=yes
+
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no
@@ -50,18 +54,128 @@ confidence=
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
-disable=C,R,W0613,W0511,W0212,W0201,W0106,W0603,W0621,W0703,W1201,W1203,E1136,W1514,E1101,W0221,W0105,E0401,abstract-method,W0707
-# E1101 for function binding
-# W0221 for Function class
-# W0105 for comment strings
-# E0401 for missing imports
-# W0707 for not reraising
+disable=print-statement,
+        parameter-unpacking,
+        unpacking-in-except,
+        old-raise-syntax,
+        backtick,
+        long-suffix,
+        old-ne-operator,
+        old-octal-literal,
+        import-star-module-level,
+        non-ascii-bytes-literal,
+        raw-checker-failed,
+        bad-inline-option,
+        locally-disabled,
+        locally-enabled,
+        file-ignored,
+        suppressed-message,
+        useless-suppression,
+        deprecated-pragma,
+        apply-builtin,
+        basestring-builtin,
+        buffer-builtin,
+        cmp-builtin,
+        coerce-builtin,
+        execfile-builtin,
+        file-builtin,
+        long-builtin,
+        raw_input-builtin,
+        reduce-builtin,
+        standarderror-builtin,
+        unicode-builtin,
+        xrange-builtin,
+        coerce-method,
+        delslice-method,
+        getslice-method,
+        setslice-method,
+        no-absolute-import,
+        old-division,
+        dict-iter-method,
+        dict-view-method,
+        next-method-called,
+        metaclass-assignment,
+        indexing-exception,
+        raising-string,
+        reload-builtin,
+        oct-method,
+        hex-method,
+        nonzero-method,
+        cmp-method,
+        input-builtin,
+        round-builtin,
+        intern-builtin,
+        unichr-builtin,
+        map-builtin-not-iterating,
+        zip-builtin-not-iterating,
+        range-builtin-not-iterating,
+        filter-builtin-not-iterating,
+        using-cmp-argument,
+        eq-without-hash,
+        div-method,
+        idiv-method,
+        rdiv-method,
+        exception-message-attribute,
+        invalid-str-codec,
+        sys-max-int,
+        bad-python3-import,
+        deprecated-string-function,
+        deprecated-str-translate-call,
+        deprecated-itertools-function,
+        deprecated-types-field,
+        next-method-defined,
+        dict-items-not-iterating,
+        dict-keys-not-iterating,
+        dict-values-not-iterating,
+        bad-indentation,
+        line-too-long,
+        missing-docstring,
+        multiple-statements,
+        bad-continuation,
+        invalid-name,
+        too-many-arguments,
+        too-many-locals,
+        superfluous-parens,
+        bad-whitespace,
+        too-many-instance-attributes,
+        wrong-import-position,
+        ungrouped-imports,
+        wrong-import-order,
+        protected-access,
+        trailing-whitespace,
+        too-many-branches,
+        too-few-public-methods,
+        too-many-statements,
+        trailing-newlines,
+        attribute-defined-outside-init,
+        too-many-return-statements,
+        too-many-public-methods,
+        unused-argument,
+        old-style-class,
+        no-init,
+        len-as-condition,
+        unneeded-not,
+        no-self-use,
+        multiple-imports,
+        no-else-return,
+        logging-not-lazy,
+        fixme,
+        redefined-outer-name,
+        unused-variable,
+        unsubscriptable-object,
+        expression-not-assigned,
+        too-many-boolean-expressions,
+        consider-using-ternary,
+        invalid-unary-operand-type,
+        relative-import,
+        deprecated-lambda
+
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
 # multiple time (only on the command line, not in the configuration file where
 # it should appear only once). See also the "--disable" option for examples.
-enable=c-extension-no-member,use-a-generator, no-else-return
+enable=c-extension-no-member
 
 
 [REPORTS]
@@ -161,7 +275,7 @@ contextmanager-decorators=contextlib.contextmanager
 # List of members which are set dynamically and missed by pylint inference
 # system, and so shouldn't trigger E1101 when accessed. Python regular
 # expressions are accepted.
-generated-members=capnp.* cereal.* pygame.* zmq.* setproctitle.* smbus2.* usb1.* serial.* cv2.* ft4222.* carla.*
+generated-members=capnp.* cereal.* pygame.* zmq.* setproctitle.* smbus2.* usb1.* serial.* cv2.*
 
 # Tells whether missing members accessed in mixin class should be ignored. A
 # mixin class is detected if its name ends with "mixin" (case insensitive).
@@ -245,11 +359,18 @@ indent-after-paren=4
 indent-string='  '
 
 # Maximum number of characters on a single line.
-max-line-length=150
+max-line-length=100
 
 # Maximum number of lines in a module
 max-module-lines=1000
 
+# List of optional constructs for which whitespace checking is disabled. `dict-
+# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
+# `trailing-comma` allows a space between comma and closing bracket: (a, ).
+# `empty-line` allows space-only lines.
+no-space-check=trailing-comma,
+               dict-separator
+
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no
@@ -456,14 +577,9 @@ known-standard-library=
 # Force import order to recognize a module as part of a third party library.
 known-third-party=enchant
 
-[STRING]
-
-# This flag controls whether the implicit-str-concat should generate a warning
-# on implicit string concatenation in sequences defined over several lines.
-check-str-concat-over-line-jumps=yes
 
 [EXCEPTIONS]
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=builtins.Exception
+overgeneral-exceptions=Exception

.travis.yml

@@ -0,0 +1,23 @@
+sudo: required
+
+services:
+  - docker
+
+install:
+  - docker build -t tmppilot -f Dockerfile.openpilot .
+
+script:
+  - docker run
+      tmppilot /bin/sh -c 'cd /tmp/openpilot/selfdrive/test/ && ./test_fingerprints.py'
+  - docker run
+      tmppilot /bin/sh -c 'cd /tmp/openpilot/ && pyflakes $(find . -iname "*.py" | grep -vi "^\./pyextra.*" | grep -vi "^\./panda")'
+  - docker run
+      tmppilot /bin/sh -c 'cd /tmp/openpilot/ && pylint $(find . -iname "*.py" | grep -vi "^\./pyextra.*" | grep -vi "^\./panda"); exit $(($? & 3))'
+  - docker run tmppilot /bin/sh -c 'cd /tmp/openpilot/ && make -C cereal && python -m unittest discover common'
+  - docker run tmppilot /bin/sh -c 'cd /tmp/openpilot/ && make -C cereal && python -m unittest discover selfdrive/can'
+  - docker run tmppilot /bin/sh -c 'cd /tmp/openpilot/ && make -C cereal && python -m unittest discover selfdrive/boardd'
+  - docker run tmppilot /bin/sh -c 'cd /tmp/openpilot/ && make -C cereal && python -m unittest discover selfdrive/controls'
+  - docker run tmppilot /bin/sh -c 'cd /tmp/openpilot/ && python -m unittest discover selfdrive/loggerd'
+  - docker run
+      -v "$(pwd)"/selfdrive/test/tests/plant/out:/tmp/openpilot/selfdrive/test/tests/plant/out
+      tmppilot /bin/sh -c 'cd /tmp/openpilot/selfdrive/test/tests/plant && OPTEST=1 ./test_longitudinal.py'

.vscode/extensions.json

@@ -1,11 +0,0 @@
-{
-  "recommendations": [
-    "ms-python.python",
-    "ms-vscode.cpptools",
-    "elagil.pre-commit-helper",
-    "charliermarsh.ruff",
-    "JamiTech.simply-blame",
-    "k--kato.intellij-idea-keybindings",
-    "trinm1709.dracula-theme-from-intellij"
-  ]
-}

.vscode/launch.json

@@ -1,85 +0,0 @@
-{
-  "version": "0.2.0",
-  "inputs": [
-    {
-      "id": "python_process",
-      "type": "pickString",
-      "description": "Select the process to debug",
-      "options": [
-        "selfdrive/controls/controlsd.py",
-        "system/timed/timed.py",
-        "tools/sim/run_bridge.py"
-      ]
-    },
-    {
-      "id": "cpp_process",
-      "type": "pickString",
-      "description": "Select the process to debug",
-      "options": [
-        "selfdrive/ui/ui"
-      ]
-    },
-    {
-      "id": "args",
-      "description": "Arguments to pass to the process",
-      "type": "promptString"
-    },
-    {
-      "id": "replayArg",
-      "type": "promptString",
-      "description": "Enter route or segment to replay."
-    }
-  ],
-  "configurations": [
-    {
-      "name": "Python: openpilot Process",
-      "type": "debugpy",
-      "request": "launch",
-      "program": "${input:python_process}",
-      "console": "integratedTerminal",
-      "justMyCode": true,
-      "args": "${input:args}"
-    },
-    {
-      "name": "C++: openpilot Process",
-      "type": "cppdbg",
-      "request": "launch",
-      "program": "${workspaceFolder}/${input:cpp_process}",
-      "cwd": "${workspaceFolder}"
-    },
-    {
-      "name": "Attach LLDB to Replay drive",
-      "type": "lldb",
-      "request": "attach",
-      "pid": "${command:pickMyProcess}",
-      "initCommands": [
-        "script import time; time.sleep(3)"
-      ]
-    },
-    {
-      "name": "Replay drive",
-      "type": "debugpy",
-      "request": "launch",
-      "program": "${workspaceFolder}/opendbc/safety/tests/safety_replay/replay_drive.py",
-      "args": [
-        "${input:replayArg}"
-      ],
-      "console": "integratedTerminal",
-      "justMyCode": false,
-      "env": {
-        "PYTHONPATH": "${workspaceFolder}"
-      },
-      "subProcess": true,
-      "stopOnEntry": false
-    }
-  ],
-  "compounds": [
-    {
-      "name": "Replay drive + Safety LLDB",
-      "configurations": [
-        "Replay drive",
-        "Attach LLDB to Replay drive"
-      ]
-    }
-  ]
-}

.vscode/settings.json

@@ -1,41 +0,0 @@
-{
-  "editor.tabSize": 2,
-  "editor.insertSpaces": true,
-  "editor.renderWhitespace": "trailing",
-  "files.trimTrailingWhitespace": true,
-  "terminal.integrated.defaultProfile.linux": "dragonpilot",
-  "terminal.integrated.profiles.linux": {
-    "dragonpilot": {
-      "path": "bash",
-      "args": ["-c", "distrobox enter dp"]
-    }
-  },
-  "search.exclude": {
-    "**/.git": true,
-    "**/.venv": true,
-    "**/__pycache__": true,
-    "msgq_repo/": true,
-    "rednose/": true,
-    "rednose_repo/": true,
-    "openpilot/": true,
-    "teleoprtc_repo/": true,
-    "tinygrad/": true,
-    "tinygrad_repo/": true
-  },
-  "files.exclude": {
-    "**/.git": true,
-    "**/.venv": true,
-    "**/__pycache__": true
-  },
-  "python.analysis.exclude": [
-    "**/.git",
-    "**/.venv",
-    "**/__pycache__",
-    // exclude directories that should be using the symlinked version
-    "common/**",
-    "selfdrive/**",
-    "system/**",
-    "third_party/**",
-    "tools/**",
-  ]
-}

ALKA_DESIGN.md

@@ -1,140 +0,0 @@
-# ALKA (Always-on Lane Keeping Assist) Design v3
-
-## Overview
-
-ALKA enables lateral control (steering) when ACC Main is ON, without requiring cruise to be engaged. This allows lane keeping assist to function independently of longitudinal control.
-
-**Simplified Behavior (v3):**
-- All brands use direct tracking: `lkas_on = acc_main_on`
-- No button/toggle tracking (removed TJA, LKAS button, LKAS HUD)
-- ACC Main ON = ALKA enabled, ACC Main OFF = ALKA disabled
-
----
-
-## Per-Brand Summary
-
-| Brand | Status | ACC Main Source | Notes |
-|-------|--------|-----------------|-------|
-| Body | Disabled | - | No steering capability |
-| Chrysler | Disabled | - | Needs special handling |
-| Ford | Enabled | EngBrakeData (0x165) CcStat | |
-| GM | Disabled | - | No ACC Main signal |
-| Honda Nidec | Enabled | SCM_FEEDBACK (0x326) MAIN_ON | |
-| Honda Bosch | Enabled | SCM_FEEDBACK (0x326) MAIN_ON | |
-| Hyundai | Enabled | SCC11 (0x420) bit 0 | |
-| Hyundai CAN-FD | Enabled | SCC_CONTROL (0x1A0) bit 66 | |
-| Hyundai Legacy | Enabled | SCC11 (0x420) bit 0 | |
-| Mazda | Enabled | CRZ_CTRL (0x21C) bit 17 | |
-| Nissan | Enabled | CRUISE_THROTTLE (0x239) bit 17 | |
-| PSA | Disabled | - | Not implemented |
-| Rivian | Disabled | - | Different architecture |
-| Subaru | Enabled | CruiseControl (0x240) bit 40 | |
-| Subaru Preglobal | Enabled | CruiseControl (0x144) bit 48 | |
-| Tesla | Disabled | - | Different architecture |
-| Toyota | Enabled | PCM_CRUISE_2 (0x1D3) bit 15 | |
-| Toyota (UNSUPPORTED_DSU) | Enabled | DSU_CRUISE (0x365) bit 0 | |
-| VW MQB | Enabled | TSK_06 TSK_Status (>=2) | |
-| VW PQ | Enabled | Motor_5 (0x480) bit 50 (long) | |
-
----
-
-## Permission Model
-
-Lateral control requires checks at both layers. Normal path uses `controls_allowed`, ALKA path uses additional checks.
-
-| Check | Panda | openpilot | Notes |
-|-------|:-----:|:---------:|-------|
-| **Normal Path** |
-| `controls_allowed` (cruise engaged) | ✓ | ✓ | Either this OR ALKA path |
-| **ALKA Path** |
-| `alka_allowed` (brand supports) | ✓ | ✓ | Set per brand in safety init |
-| `ALT_EXP_ALKA` (user enabled) | ✓ | ✓ | alternativeExperience flag |
-| `lkas_on` (ACC Main ON) | ✓ | ✓ | Tracked via CAN messages |
-| `vehicle_moving` / `!standstill` | ✓ | ✓ | |
-| **openpilot Additional** |
-| `gear_ok` (not P/N/R) | ✗ | ✓ | Python layer only |
-| `calibrated` | ✗ | ✓ | Python layer only |
-| `seatbelt latched` | ✗ | ✓ | Python layer only |
-| `doors closed` | ✗ | ✓ | Python layer only |
-| `!steerFaultTemporary` | ✗ | ✓ | Python layer only |
-| `!steerFaultPermanent` | ✗ | ✓ | Python layer only |
-
----
-
-## Data Flow
-
-```
-┌─────────────────────────────────────────────────────────────────────┐
-│                         CAN Bus                                      │
-└─────────────────────────────────────────────────────────────────────┘
-                    │                              │
-                    ▼                              ▼
-┌─────────────────────────────────┐  ┌─────────────────────────────────┐
-│  Safety Layer (panda C code)    │  │  Python Layer                   │
-│                                 │  │                                 │
-│  rx_hook:                       │  │  carstate.py:                   │
-│  - Parse ACC Main signal        │  │  - Parse cruiseState.available  │
-│  - Set lkas_on = acc_main_on    │  │  - Set self.lkas_on             │
-│                                 │  │                                 │
-│  lat_control_allowed():         │  └─────────────┬───────────────────┘
-│  - Check lkas_on + other flags  │                │
-│  - Gate steering commands       │                ▼
-└─────────────────────────────────┘  ┌─────────────────────────────────┐
-                                     │  card.py:                       │
-                                     │  - Publish carStateExt.lkasOn   │
-                                     └─────────────┬───────────────────┘
-                                                   │
-                                                   ▼
-                                     ┌─────────────────────────────────┐
-                                     │  controlsd.py:                  │
-                                     │  - Read carStateExt.lkasOn      │
-                                     │  - Check ALKA conditions        │
-                                     │  - Set CC.latActive             │
-                                     └─────────────────────────────────┘
-```
-
-### Key Files
-
-| File | Purpose |
-|------|---------|
-| `custom.capnp` | Defines `CarStateExt` struct with `lkasOn` field |
-| `log.capnp` | Includes `carStateExt` in event union |
-| `interfaces.py` | Defines `self.lkas_on = False` default in `CarStateBase` |
-| `carstate.py` (per brand) | Tracks `lkas_on` based on ACC Main |
-| `card.py` | Publishes `carStateExt.lkasOn` from `CI.CS.lkas_on` |
-| `controlsd.py` | Reads `carStateExt.lkasOn` to determine `alka_active` |
-
----
-
-## ACC Main Tracking
-
-All brands use simple direct tracking:
-
-```c
-// Panda (C code)
-if (alka_allowed && (alternative_experience & ALT_EXP_ALKA)) {
-  lkas_on = acc_main_on;  // or GET_BIT(msg, bit_position)
-}
-```
-
-```python
-# Python carstate.py
-self.lkas_on = ret.cruiseState.available
-```
-
-This guard ensures:
-1. Brand supports ALKA (`alka_allowed`)
-2. User enabled ALKA (`ALT_EXP_ALKA`)
-
-Without both conditions, no ACC Main tracking occurs, and ALKA remains disabled.
-
----
-
-## Testing
-
-Safety tests verify:
-- `alka_allowed` flag set correctly per brand
-- ACC Main tracking updates `lkas_on` directly
-- `lat_control_allowed()` returns true only when all conditions met
-- Steering TX blocked when ALKA conditions not met
-- Bus routing variants (camera_scc, unsupported_dsu)

BRANCHES.md

@@ -1,91 +0,0 @@
-```mermaid
-flowchart TD
-    B000["devel-staging"] ---> CORE["core"]
-    CORE ---> CORE_001["core-feat/params"]
-    CORE_001 ---> CORE_002["core-feat/panel"]
-    CORE_002 ---> CORE_003["core-feat/safety-ext"]
-    CORE_003 ---> MIN["min"]
-    MIN ---> MIN_001["min-feat/ui/display-mode"]
-    MIN ---> MIN_002["min-feat/dev/model-selector"]
-    MIN ---> MIN_003["min-feat/lat/lca"]
-    MIN ---> MIN_004["min-feat/dev/on-off-road"]
-    MIN ---> MIN_005["min-feat/ui/hide-hud"]
-    MIN ---> MIN_006["min-feat/lon/ext-radar"]
-    MIN ---> MIN_007["min-feat/lat/road-edge-detection"]
-    MIN ---> MIN_008["min-feat/ui/rainbow-path"]
-    MIN ---> MIN_009["min-feat/lon/acm"]
-    MIN ---> MIN_010["min-feat/lon/aem"]
-    MIN ---> MIN_011["min-feat/lon/dtsc"]
-    MIN ---> MIN_012["min-feat/lon/apm"]
-    MIN ---> MIN_013["min-feat/lon/dasr"]
-    MIN ---> MIN_014["min-feat/dev/alert-mode"]
-    MIN ---> MIN_015["min-feat/dev/auto-shutdown"]
-    MIN ---> MIN_016["min-feat/ui/lead-stats"]
-    MIN ---> MIN_017["min-feat/ui/border-indicator"]
-    MIN ---> MIN_018["min-feat/dev/delay-loggerd"]
-    MIN ---> MIN_019["min-feat/dev/disable-connect"]
-    MIN ---> MIN_020["min-feat/dev/tether-on-boot"]
-    MIN ---> MIN_021["min-feat/ui/torque-bar"]
-    MIN ---> MIN_022["min-feat/ui/mici-ui-mode"]
-    MIN ---> MIN_023["min-feat/lat/lat-offset"]
-    MIN_001 ---> FULL["full"]
-    MIN_002 ---> FULL
-    MIN_003 ---> FULL
-    MIN_004 ---> FULL
-    MIN_005 ---> FULL
-    MIN_006 ---> FULL
-    MIN_007 ---> FULL
-    MIN_008 ---> FULL
-    MIN_009 ---> FULL
-    MIN_010 ---> FULL
-    MIN_011 ---> FULL
-    MIN_012 ---> FULL
-    MIN_013 ---> FULL
-    MIN_014 ---> FULL
-    MIN_015 ---> FULL
-    MIN_016 ---> FULL
-    MIN_017 ---> FULL
-    MIN_018 ---> FULL
-    MIN_019 ---> FULL
-    MIN_020 ---> FULL
-    MIN_021 ---> FULL
-    FULL ---> TOYOTA_001[brand/toyota/safety-common]
-    FULL ---> TOYOTA_002[brand/toyota/door-auto-lock-unlock]
-    FULL ---> TOYOTA_003[brand/toyota/tss1-sng]
-    FULL ---> TOYOTA_004[brand/toyota/radar-filter]
-    FULL ---> TOYOTA_005[brand/toyota/sdsu]
-    FULL ---> TOYOTA_006[brand/toyota/dsu-bypass]
-    FULL ---> TOYOTA_007[brand/toyota/zss]
-    FULL ---> TOYOTA_008[brand/toyota/stock-lon]
-    FULL ---> VAG_001[brand/vag/a0-sng]
-    FULL ---> VAG_002[brand/vag/pq-steering-patch]
-    FULL ---> VAG_003[brand/vag/pq-no-dashcam]
-    FULL ---> VAG_004[brand/vag/avoid-eps-lockout]
-    FULL ---> HKG_001[brand/hkg/smdps]
-    FULL ---> HONDA_001[brand/honda/eps-mod]
-    FULL ---> HONDA_002[brand/honda/nidec-stock-long]
-    FULL ---> SUBARU_001[brand/subaru/torque-3071]
-    TOYOTA_001 ---> TOYOTA[pre-toyota]
-    TOYOTA_002 ---> TOYOTA
-    TOYOTA_003 ---> TOYOTA
-    TOYOTA_004 ---> TOYOTA
-    TOYOTA_005 ---> TOYOTA
-    TOYOTA_006 ---> TOYOTA
-    TOYOTA_007 ---> TOYOTA
-    TOYOTA_008 ---> TOYOTA
-    VAG_001 ---> VAG[pre-vag]
-    VAG_002 ---> VAG
-    VAG_003 ---> VAG
-    VAG_004 ---> VAG
-    HKG_001 ---> HKG[pre-hkg]
-    HONDA_001 ---> HONDA[pre-honda]
-    SUBARU_001 ---> SUBARU[pre-subaru]
-    TOYOTA ---> PRE[pre]
-    VAG ---> PRE
-    HKG ---> PRE
-    HONDA ---> PRE
-    SUBARU ---> PRE
-    PRE ---> PRE_PATCH[pre-patch]
-    PRE_PATCH ---> PREBUILD[pre-build]
-    PREBUILD ---> VERSION[x.x.x]
-```

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# How to contribute
+
+Our software is open source so you can solve your own problems without needing help from others. And if you solve a problem and are so kind, you can upstream it for the rest of the world to use.
+
+Most open source development activity is coordinated through our [Discord](https://discord.comma.ai). A lot of documentation is available on our [medium](https://medium.com/@comma_ai/)
+
+## Getting Started
+
+ * Join our [Discord](https://discord.comma.ai)
+ * Make sure you have a [GitHub account](https://github.com/signup/free)
+ * Fork [our repositories](https://github.com/commaai) on GitHub
+
+## Testing
+
+### Local Testing
+
+You can test your changes on your machine by running `run_docker_tests.sh`. This will run some automated tests in docker against your code. 
+
+### Automated Testing
+
+All PRs are automatically checked by travis. Check out `.travis.yml` for what travis runs. Any new tests sould be added to travis.
+
+### Code Style and Linting
+
+Code is automatically check for style by travis as part of the automated tests. You can also run these yourself by running `check_code_quality.sh`. 
+
+## Car Ports (openpilot)
+
+We've released a [Model Port guide](https://medium.com/@comma_ai/openpilot-port-guide-for-toyota-models-e5467f4b5fe6) for porting to Toyota/Lexus models.
+
+If you port openpilot to a substantially new car brand, see this more generic [Brand Port guide](https://medium.com/@comma_ai/how-to-write-a-car-port-for-openpilot-7ce0785eda84). You might also be eligible for a bounty. See our bounties at [comma.ai/bounties.html](https://comma.ai/bounties.html)

Dockerfile.openpilot

@@ -1,38 +1,44 @@
-FROM ubuntu:24.04
+FROM ubuntu:16.04
+ENV PYTHONUNBUFFERED 1
 
-ENV PYTHONUNBUFFERED=1
+RUN apt-get update && apt-get install -y \
+    autoconf \
+    build-essential \
+    clang \
+    wget \
+    bzip2 \
+    git \
+    libglib2.0-0 \
+    libtool \
+    python-pip \
+    libzmq5-dev \
+    libffi-dev \
+    libusb-1.0-0 \
+    libssl-dev \
+    ocl-icd-libopencl1 \
+    ocl-icd-opencl-dev \
+    opencl-headers
 
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get update && \
-    apt-get install -y --no-install-recommends sudo tzdata locales && \
-    rm -rf /var/lib/apt/lists/*
+COPY phonelibs/install_capnp.sh /tmp/install_capnp.sh
+RUN /tmp/install_capnp.sh
 
-RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && locale-gen
-ENV LANG=en_US.UTF-8
-ENV LANGUAGE=en_US:en
-ENV LC_ALL=en_US.UTF-8
+RUN pip install --upgrade pip==18.0
+RUN pip install numpy==1.11.2 scipy==0.18.1 matplotlib==2.1.2
 
-ENV NVIDIA_VISIBLE_DEVICES=all
-ENV NVIDIA_DRIVER_CAPABILITIES=graphics,utility,compute
+COPY requirements_openpilot.txt /tmp/
+RUN pip install -r /tmp/requirements_openpilot.txt
 
-ARG USER=batman
-ARG USER_UID=1001
-RUN useradd -m -s /bin/bash -u $USER_UID $USER
-RUN usermod -aG sudo $USER
-RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
-USER $USER
+ENV PYTHONPATH /tmp/openpilot:$PYTHONPATH
 
-ENV OPENPILOT_PATH=/home/$USER/openpilot
-RUN mkdir -p ${OPENPILOT_PATH}
-WORKDIR ${OPENPILOT_PATH}
+COPY ./.pylintrc /tmp/openpilot/.pylintrc
+COPY ./common /tmp/openpilot/common
+COPY ./cereal /tmp/openpilot/cereal
+COPY ./opendbc /tmp/openpilot/opendbc
+COPY ./selfdrive /tmp/openpilot/selfdrive
+COPY ./phonelibs /tmp/openpilot/phonelibs
+COPY ./pyextra /tmp/openpilot/pyextra
+COPY ./panda /tmp/openpilot/panda
 
-COPY --chown=$USER . ${OPENPILOT_PATH}/
-
-ENV UV_BIN="/home/$USER/.local/bin/"
-ENV VIRTUAL_ENV=${OPENPILOT_PATH}/.venv
-ENV PATH="$UV_BIN:$VIRTUAL_ENV/bin:$PATH"
-RUN tools/setup_dependencies.sh && \
-    sudo rm -rf /var/lib/apt/lists/*
-
-USER root
-RUN git config --global --add safe.directory '*'
+RUN mkdir -p /tmp/openpilot/selfdrive/test/out
+RUN make -C /tmp/openpilot/selfdrive/controls/lib/longitudinal_mpc clean
+RUN make -C /tmp/openpilot/selfdrive/controls/lib/lateral_mpc clean

Jenkinsfile

@@ -1,260 +0,0 @@
-def retryWithDelay(int maxRetries, int delay, Closure body) {
-  for (int i = 0; i < maxRetries; i++) {
-    try {
-      return body()
-    } catch (Exception e) {
-      sleep(delay)
-    }
-  }
-  throw Exception("Failed after ${maxRetries} retries")
-}
-
-def device(String ip, String step_label, String cmd) {
-  withCredentials([file(credentialsId: 'id_rsa', variable: 'key_file')]) {
-    def ssh_cmd = """
-ssh -o ConnectTimeout=5 -o ServerAliveInterval=5 -o ServerAliveCountMax=2 -o BatchMode=yes -o StrictHostKeyChecking=no -i ${key_file} 'comma@${ip}' exec /usr/bin/bash <<'END'
-
-set -e
-
-export TERM=xterm-256color
-
-shopt -s huponexit # kill all child processes when the shell exits
-
-export CI=1
-export PYTHONWARNINGS=error
-#export LOGPRINT=debug # this has gotten too spammy...
-export TEST_DIR=${env.TEST_DIR}
-export SOURCE_DIR=${env.SOURCE_DIR}
-export GIT_BRANCH=${env.GIT_BRANCH}
-export GIT_COMMIT=${env.GIT_COMMIT}
-export CI_ARTIFACTS_TOKEN=${env.CI_ARTIFACTS_TOKEN}
-export GITHUB_COMMENTS_TOKEN=${env.GITHUB_COMMENTS_TOKEN}
-export AZURE_TOKEN='${env.AZURE_TOKEN}'
-# only use 1 thread for tici tests since most require HIL
-export PYTEST_ADDOPTS="-n0 -s"
-
-
-export GIT_SSH_COMMAND="ssh -i /data/gitkey"
-
-source ~/.bash_profile
-if [ -f /TICI ]; then
-  source /etc/profile
-
-  rm -rf /tmp/tmp*
-  rm -rf ~/.commacache
-  rm -rf /dev/shm/*
-  rm -rf /dev/tmp/tmp*
-
-  if ! systemctl is-active --quiet systemd-resolved; then
-    echo "restarting resolved"
-    sudo systemctl start systemd-resolved
-    sleep 3
-  fi
-
-  # restart aux USB
-  if [ -e /sys/bus/usb/drivers/hub/3-0:1.0 ]; then
-    echo "restarting aux usb"
-    echo "3-0:1.0" | sudo tee /sys/bus/usb/drivers/hub/unbind
-    sleep 0.5
-    echo "3-0:1.0" | sudo tee /sys/bus/usb/drivers/hub/bind
-  fi
-fi
-if [ -f /data/openpilot/launch_env.sh ]; then
-  source /data/openpilot/launch_env.sh
-fi
-
-ln -snf ${env.TEST_DIR} /data/pythonpath
-
-cd ${env.TEST_DIR} || true
-time ${cmd}
-END"""
-
-    sh script: ssh_cmd, label: step_label
-  }
-}
-
-def deviceStage(String stageName, String deviceType, List extra_env, def steps) {
-  stage(stageName) {
-    if (currentBuild.result != null) {
-        return
-    }
-
-    if (isReplay()) {
-      error("REPLAYING TESTS IS NOT ALLOWED. FIX THEM INSTEAD.")
-    }
-
-    def extra = extra_env.collect { "export ${it}" }.join('\n');
-    def branch = env.BRANCH_NAME ?: 'master';
-    def gitDiff = sh returnStdout: true, script: 'curl -s -H "Authorization: Bearer ${GITHUB_COMMENTS_TOKEN}" https://api.github.com/repos/commaai/openpilot/compare/master...${GIT_BRANCH} | jq .files[].filename || echo "/"', label: 'Getting changes'
-
-    lock(resource: "", label: deviceType, inversePrecedence: true, variable: 'device_ip', quantity: 1, resourceSelectStrategy: 'random') {
-      docker.image('ghcr.io/commaai/alpine-ssh').inside('--user=root') {
-        timeout(time: 35, unit: 'MINUTES') {
-          retry (3) {
-            def date = sh(script: 'date', returnStdout: true).trim();
-            device(device_ip, "set time", "date -s '" + date + "'")
-            device(device_ip, "git checkout", extra + "\n" + readFile("selfdrive/test/setup_device_ci.sh"))
-          }
-          steps.each { item ->
-            def name = item[0]
-            def cmd = item[1]
-
-            def args = item[2]
-            def diffPaths = args.diffPaths ?: []
-            def cmdTimeout = args.timeout ?: 9999
-
-            if (branch != "master" && !branch.contains("__jenkins_loop_") && diffPaths && !hasPathChanged(gitDiff, diffPaths)) {
-              println "Skipping ${name}: no changes in ${diffPaths}."
-              return
-            } else {
-              timeout(time: cmdTimeout, unit: 'SECONDS') {
-                device(device_ip, name, cmd)
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-}
-
-def hasPathChanged(String gitDiff, List<String> paths) {
-  for (path in paths) {
-    if (gitDiff.contains(path)) {
-      return true
-    }
-  }
-  return false
-}
-
-def isReplay() {
-  def replayClass = "org.jenkinsci.plugins.workflow.cps.replay.ReplayCause"
-  return currentBuild.rawBuild.getCauses().any{ cause -> cause.toString().contains(replayClass) }
-}
-
-def setupCredentials() {
-  withCredentials([
-    string(credentialsId: 'azure_token', variable: 'AZURE_TOKEN'),
-  ]) {
-    env.AZURE_TOKEN = "${AZURE_TOKEN}"
-  }
-
-  withCredentials([
-    string(credentialsId: 'ci_artifacts_pat', variable: 'CI_ARTIFACTS_TOKEN'),
-  ]) {
-    env.CI_ARTIFACTS_TOKEN = "${CI_ARTIFACTS_TOKEN}"
-  }
-
-  withCredentials([
-    string(credentialsId: 'post_comments_github_pat', variable: 'GITHUB_COMMENTS_TOKEN'),
-  ]) {
-    env.GITHUB_COMMENTS_TOKEN = "${GITHUB_COMMENTS_TOKEN}"
-  }
-}
-
-def step(String name, String cmd, Map args = [:]) {
-  return [name, cmd, args]
-}
-
-node {
-  env.CI = "1"
-  env.PYTHONWARNINGS = "error"
-  env.TEST_DIR = "/data/openpilot"
-  env.SOURCE_DIR = "/data/openpilot_source/"
-  setupCredentials()
-
-  env.GIT_BRANCH = checkout(scm).GIT_BRANCH
-  env.GIT_COMMIT = checkout(scm).GIT_COMMIT
-
-  def excludeBranches = ['__nightly', 'devel', 'devel-staging', 'release3', 'release3-staging',
-                         'release-tici', 'release-tizi', 'release-tizi-staging', 'testing-closet*', 'hotfix-*']
-  def excludeRegex = excludeBranches.join('|').replaceAll('\\*', '.*')
-
-  if (env.BRANCH_NAME != 'master' && !env.BRANCH_NAME.contains('__jenkins_loop_')) {
-    properties([
-        disableConcurrentBuilds(abortPrevious: true)
-    ])
-  }
-
-  try {
-    if (env.BRANCH_NAME == 'devel-staging') {
-      deviceStage("build release-tizi-staging", "tizi-needs-can", [], [
-        step("build release-tizi-staging", "RELEASE_BRANCH=release-tizi-staging $SOURCE_DIR/release/build_release.sh"),
-      ])
-    }
-
-    if (env.BRANCH_NAME == '__nightly') {
-      parallel (
-        'nightly': {
-          deviceStage("build nightly", "tizi-needs-can", [], [
-            step("build nightly", "RELEASE_BRANCH=nightly $SOURCE_DIR/release/build_release.sh"),
-          ])
-        },
-        'nightly-dev': {
-          deviceStage("build nightly-dev", "tizi-needs-can", [], [
-            step("build nightly-dev", "PANDA_DEBUG_BUILD=1 RELEASE_BRANCH=nightly-dev $SOURCE_DIR/release/build_release.sh"),
-          ])
-        },
-      )
-    }
-
-    if (!env.BRANCH_NAME.matches(excludeRegex)) {
-    parallel (
-      'onroad tests': {
-        deviceStage("onroad", "tizi-needs-can", ["UNSAFE=1"], [
-          step("build openpilot", "cd system/manager && ./build.py"),
-          step("check dirty", "release/check-dirty.sh"),
-          step("onroad tests", "pytest selfdrive/test/test_onroad.py -s", [timeout: 60]),
-        ])
-      },
-      'HW + Unit Tests': {
-        deviceStage("tizi-hardware", "tizi-common", ["UNSAFE=1"], [
-          step("build", "cd system/manager && ./build.py"),
-          step("test power draw", "pytest -s system/hardware/tici/tests/test_power_draw.py"),
-          step("test encoder", "LD_LIBRARY_PATH=/usr/local/lib pytest system/loggerd/tests/test_encoder.py", [diffPaths: ["system/loggerd/"]]),
-          step("test manager", "pytest system/manager/test/test_manager.py"),
-        ])
-      },
-      'camerad OX03C10': {
-        deviceStage("OX03C10", "tizi-ox03c10", ["UNSAFE=1"], [
-          step("build", "cd system/manager && ./build.py"),
-          step("test pandad", "pytest selfdrive/pandad/tests/test_pandad.py"),
-          step("test camerad", "pytest system/camerad/test/test_camerad.py", [timeout: 90]),
-        ])
-      },
-      'camerad OS04C10': {
-        deviceStage("OS04C10", "tici-os04c10", ["UNSAFE=1"], [
-          step("build", "cd system/manager && ./build.py"),
-          step("test pandad", "pytest selfdrive/pandad/tests/test_pandad.py"),
-          step("test camerad", "pytest system/camerad/test/test_camerad.py", [timeout: 90]),
-        ])
-      },
-      'sensord': {
-        deviceStage("LSM + MMC", "tizi-lsmc", ["UNSAFE=1"], [
-          step("build", "cd system/manager && ./build.py"),
-          step("test sensord", "pytest system/sensord/tests/test_sensord.py"),
-        ])
-      },
-      'replay': {
-        deviceStage("model-replay", "tizi-replay", ["UNSAFE=1"], [
-          step("build", "cd system/manager && ./build.py", [diffPaths: ["selfdrive/modeld/", "tinygrad_repo", "selfdrive/test/process_replay/model_replay.py"]]),
-          step("model replay", "selfdrive/test/process_replay/model_replay.py", [diffPaths: ["selfdrive/modeld/", "tinygrad_repo", "selfdrive/test/process_replay/model_replay.py"]]),
-        ])
-      },
-      'tizi': {
-        deviceStage("tizi", "tizi", ["UNSAFE=1"], [
-          step("build openpilot", "cd system/manager && ./build.py"),
-          step("test pandad loopback", "pytest selfdrive/pandad/tests/test_pandad_loopback.py"),
-          step("test pandad spi", "pytest selfdrive/pandad/tests/test_pandad_spi.py"),
-          step("test amp", "pytest system/hardware/tici/tests/test_amplifier.py"),
-          step("test qcomgpsd", "pytest system/qcomgpsd/tests/test_qcomgpsd.py", [diffPaths: ["system/qcomgpsd/"]]),
-        ])
-      },
-
-    )
-    }
-  } catch (Exception e) {
-    currentBuild.result = 'FAILED'
-    throw e
-  }
-}

LICENSE.md

@@ -1,30 +0,0 @@
-Copyright (c) 2019, Rick Lan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, and/or sublicense, 
-for non-commercial purposes only, subject to the following conditions:
-
-- The above copyright notice and this permission notice shall be included in 
-  all copies or substantial portions of the Software.
-- Commercial use (e.g. use in a product, service, or activity intended to 
-  generate revenue) is prohibited without explicit written permission from 
-  the copyright holder.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
----
-Copyright (c) 2018, Comma.ai, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy 
-of this software and associated documentation files (the "Software"), to deal 
-in the Software without restriction, including without limitation the rights 
-to use, copy, modify, merge, publish, distribute, sublicense, 
-and/or sell copies of the Software, and to permit persons to whom the 
-Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in 
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,9 @@
+
+code_dir := $(shell pwd)
+
+# TODO: Add a global build system
+
+.PHONY: all
+all:
+	cd selfdrive && PYTHONPATH=$(code_dir) PREPAREONLY=1 ./manager.py
+

README.md

@@ -1,74 +1,232 @@
-![](dragonpilot/selfdrive/assets/dragonpilot.png)
+[![](https://i.imgur.com/xY2gdHv.png)](#)
 
-[Read this in English](README_EN.md)
+Welcome to openpilot
+======
 
-# **🐲 dragonpilot - 賦予您的愛車「龍」之魂**
+[openpilot](http://github.com/commaai/openpilot) is an open source driving agent. Currently, it performs the functions of Adaptive Cruise Control (ACC) and Lane Keeping Assist System (LKAS) for selected Honda, Toyota, Acura, Lexus, Chevrolet, Hyundai, Kia. It's about on par with Tesla Autopilot and GM Super Cruise, and better than [all other manufacturers](http://www.thedrive.com/tech/5707/the-war-for-autonomous-driving-part-iii-us-vs-germany-vs-japan).
 
-**我們與您一同翱翔於更智慧、更貼心的駕駛旅程。**
+The openpilot codebase has been written to be concise and to enable rapid prototyping. We look forward to your contributions - improving real vehicle automation has never been easier.
 
-## **👋 嘿, 朋友，歡迎您的到來！**
+Table of Contents
+=======================
 
-`dragonpilot` 誕生於 2019 年，由三位早期的 openpilot 華人玩家共同創立。初衷很簡單：為廣大的華人用戶、玩家們提供一個友善的交流環境、更簡便的設定協助，並加入更多適合在地使用的貼心功能。
+* [Community](#community)
+* [Hardware](#hardware)
+* [Supported Cars](#supported-cars)
+* [Community Maintained Cars](#community-maintained-cars)
+* [In Progress Cars](#in-progress-cars)
+* [How can I add support for my car?](#how-can-i-add-support-for-my-car)
+* [Directory structure](#directory-structure)
+* [User Data / chffr Account / Crash Reporting](#user-data--chffr-account--crash-reporting)
+* [Testing on PC](#testing-on-pc)
+* [Contributing](#contributing)
+* [Licensing](#licensing)
 
-我們深知在地化的重要性，特別是語言的親切感。因此，我們率先導入了完整的中文介面，讓 `dragonpilot` 迅速在華語地區累積了口碑，也讓華人的使用者數量在全球名列前茅。這份來自在地的支持，是我們持續前進的最大動力。
+---
 
-我們以功能強大的 [openpilot](https://github.com/commaai/openpilot) 為基礎——這套據美國消費者報告評測優於市售車方案的開源輔助駕駛系統——融入了更多在地化的巧思與客製化的溫度，希望能打造出最符合您需求的駕駛夥伴。(您也可以參考我們 repo 中保留的 [openpilot 原始說明檔案](README_OPENPILOT.md))
+Community
+------
 
-取名 `dragonpilot`，是因為我們希望它能像神話中的「龍」一樣，既強大又充滿智慧，為您的行車安全保駕護航。龍，在我們華人文化中，更是吉祥與力量的象徵，也代表著我們的根源與驕傲。
+openpilot is developed by [comma.ai](https://comma.ai/) and users like you.
 
-## **✨ dragonpilot 的里程碑**
+We have a [Twitter you should follow](https://twitter.com/comma_ai).
 
-我們不僅保留了 openpilot 的核心優勢，更達成了許多從社群回饋中誕生的里程碑，這些是我們引以為傲的足跡：
+Also, we have a several thousand people community on [Discord](https://discord.comma.ai).
 
-* **🚘 全時置中車道維持 (ALKA)**
+<table>
+  <tr>
+    <td><a href="https://www.youtube.com/watch?v=ICOIin4p70w" title="YouTube" rel="noopener"><img src="https://i.imgur.com/gBTo7yB.png"></a></td>
+    <td><a href="https://www.youtube.com/watch?v=1zCtj3ckGFo" title="YouTube" rel="noopener"><img src="https://i.imgur.com/gNhhcep.png"></a></td>
+    <td><a href="https://www.youtube.com/watch?v=Qd2mjkBIRx0" title="YouTube" rel="noopener"><img src="https://i.imgur.com/tFnSexp.png"></a></td>
+    <td><a href="https://www.youtube.com/watch?v=ju12vlBm59E" title="YouTube" rel="noopener"><img src="https://i.imgur.com/3BKiJVy.png"></a></td>
+  </tr>
+  <tr>
+    <td><a href="https://www.youtube.com/watch?v=Z5VY5FzgNt4" title="YouTube" rel="noopener"><img src="https://i.imgur.com/3I9XOK2.png"></a></td>
+    <td><a href="https://www.youtube.com/watch?v=blnhZC7OmMg" title="YouTube" rel="noopener"><img src="https://i.imgur.com/f9IgX6s.png"></a></td>
+    <td><a href="https://www.youtube.com/watch?v=iRkz7FuJsA8" title="YouTube" rel="noopener"><img src="https://i.imgur.com/Vo5Zvmn.png"></a></td>
+    <td><a href="https://www.youtube.com/watch?v=IHjEqAKDqjM" title="YouTube" rel="noopener"><img src="https://i.imgur.com/V9Zd81n.png"></a></td>
+  </tr>
+</table>
 
-  這不只是一個功能，更是 `dragonpilot` 的哲學。我們最早於 [0.6.2 版本](https://github.com/dragonpilot-community/dragonpilot/blob/2861467183d62151024320447ba04d18fc3fe1e6/selfdrive/car/toyota/carstate.py#L199) 時便實現了這個功能，其開發歷程始於 2017 Lexus IS300h，接著擴展至 Toyota 全車系，並逐步延伸到其他支援的品牌。它能溫柔地輔助您，讓車輛始終穩定地保持在車道中央，提供一份額外的安心與從容。
+Hardware
+------
 
-* **🌐 率先導入多國語言介面**
+At the moment openpilot supports the [EON Dashcam DevKit](https://comma.ai/shop/products/eon-dashcam-devkit). A [panda](https://shop.comma.ai/products/panda-obd-ii-dongle) and a [giraffe](https://comma.ai/shop/products/giraffe/) are recommended tools to interface the EON with the car. We'd like to support other platforms as well.
 
-  在官方 openpilot 還未支援前，我們便已將多國語言介面實現。`dragonpilot` 完整支援繁體中文、簡體中文與英文，讓操作毫無隔閡。
+Install openpilot on a neo device by entering ``https://openpilot.comma.ai`` during NEOS setup.
 
-* **💻 唯一同時支援多硬體平台**
+Supported Cars
+------
 
-  我們是唯一曾致力於讓專案同時兼容 EON、comma two、comma 3 與 Jetson 平台的社群分支，這份努力是為了服務最廣大的玩家社群。
-  此外，在 comma.ai 團隊於 0.10.0 版本宣布停止支持 comma 3 後，我們仍是唯一一個完整同時支援 comma 3、comma 3X 以及 O3、O3L、O3XL（O3 系列為副廠硬體）的社群分支。
+| Make                 | Model                    | Supported Package    | Lateral | Longitudinal   | No Accel Below   | No Steer Below | Giraffe           |
+| ---------------------| -------------------------| ---------------------| --------| ---------------| -----------------| ---------------|-------------------|
+| Acura                | ILX 2016-17              | AcuraWatch Plus      | Yes     | Yes            | 25mph<sup>1</sup>| 25mph          | Nidec             |
+| Acura                | RDX 2018                 | AcuraWatch Plus      | Yes     | Yes            | 25mph<sup>1</sup>| 12mph          | Nidec             |
+| Buick<sup>3</sup>    | Regal 2018               | Adaptive Cruise      | Yes     | Yes            | 0mph             | 7mph           | Custom<sup>7</sup>|
+| Chevrolet<sup>3</sup>| Malibu 2017              | Adaptive Cruise      | Yes     | Yes            | 0mph             | 7mph           | Custom<sup>7</sup>|
+| Chevrolet<sup>3</sup>| Volt 2017-18             | Adaptive Cruise      | Yes     | Yes            | 0mph             | 7mph           | Custom<sup>7</sup>|
+| Cadillac<sup>3</sup> | ATS 2018                 | Adaptive Cruise      | Yes     | Yes            | 0mph             | 7mph           | Custom<sup>7</sup>|
+| Chrysler             | Pacifica 2018            | Adaptive Cruise      | Yes     | Stock          | 0mph             | 9mph           | FCA               |
+| Chrysler             | Pacifica Hybrid 2017-18  | Adaptive Cruise      | Yes     | Stock          | 0mph             | 9mph           | FCA               |
+| Chrysler             | Pacifica Hybrid 2019     | Adaptive Cruise      | Yes     | Stock          | 0mph             | 39mph          | FCA               |
+| GMC<sup>3</sup>      | Acadia Denali 2018       | Adaptive Cruise      | Yes     | Yes            | 0mph             | 7mph           | Custom<sup>7</sup>|
+| Holden<sup>3</sup>   | Astra 2017               | Adaptive Cruise      | Yes     | Yes            | 0mph             | 7mph           | Custom<sup>7</sup>|
+| Honda                | Accord 2018              | All                  | Yes     | Stock          | 0mph             | 3mph           | Bosch             |
+| Honda                | Civic Sedan/Coupe 2016-18| Honda Sensing        | Yes     | Yes            | 0mph             | 12mph          | Nidec             |
+| Honda                | Civic Sedan/Coupe 2019   | Honda Sensing        | Yes     | Stock          | 0mph             | 2mph           | Bosch             |
+| Honda                | Civic Hatchback 2017-19  | Honda Sensing        | Yes     | Stock          | 0mph             | 12mph          | Bosch             |
+| Honda                | CR-V 2015-16             | Touring              | Yes     | Yes            | 25mph<sup>1</sup>| 12mph          | Nidec             |
+| Honda                | CR-V 2017-19             | Honda Sensing        | Yes     | Stock          | 0mph             | 12mph          | Bosch             |
+| Honda                | CR-V Hybrid 2019         | All                  | Yes     | Stock          | 0mph             | 12mph          | Bosch             |
+| Honda                | Odyssey 2017-19          | Honda Sensing        | Yes     | Yes            | 25mph<sup>1</sup>| 0mph           | Inverted Nidec    |
+| Honda                | Passport 2019            | All                  | Yes     | Yes            | 25mph<sup>1</sup>| 12mph          | Inverted Nidec    |
+| Honda                | Pilot 2016-18            | Honda Sensing        | Yes     | Yes            | 25mph<sup>1</sup>| 12mph          | Nidec             |
+| Honda                | Pilot 2019               | All                  | Yes     | Yes            | 25mph<sup>1</sup>| 12mph          | Inverted Nidec    |
+| Honda                | Ridgeline 2017-19        | Honda Sensing        | Yes     | Yes            | 25mph<sup>1</sup>| 12mph          | Nidec             |
+| Hyundai              | Santa Fe 2019            | All                  | Yes     | Stock          | 0mph             | 0mph           | Custom<sup>6</sup>|
+| Hyundai              | Elantra 2017             | SCC + LKAS           | Yes     | Stock          | 19mph            | 34mph          | Custom<sup>6</sup>|
+| Hyundai              | Genesis 2018             | All                  | Yes     | Stock          | 19mph            | 34mph          | Custom<sup>6</sup>|
+| Jeep                 | Grand Cherokee 2017-18   | Adaptive Cruise      | Yes     | Stock          | 0mph             | 9mph           | FCA               |
+| Jeep                 | Grand Cherokee 2019      | Adaptive Cruise      | Yes     | Stock          | 0mph             | 39mph          | FCA               |
+| Kia                  | Optima 2019              | SCC + LKAS           | Yes     | Stock          | 0mph             | 0mph           | Custom<sup>6</sup>|
+| Kia                  | Sorento 2018             | All                  | Yes     | Stock          | 0mph             | 0mph           | Custom<sup>6</sup>|
+| Kia                  | Stinger 2018             | SCC + LKAS           | Yes     | Stock          | 0mph             | 0mph           | Custom<sup>6</sup>|
+| Lexus                | RX Hybrid 2016-19        | All                  | Yes     | Yes<sup>2</sup>| 0mph             | 0mph           | Toyota            |
+| Subaru               | Crosstrek 2018           | EyeSight             | Yes     | Stock          | 0mph             | 0mph           | Subaru            |
+| Subaru               | Impreza 2019             | EyeSight             | Yes     | Stock          | 0mph             | 0mph           | Subaru            |
+| Toyota               | Avalon 2016              | TSS-P                | Yes     | Yes<sup>2</sup>| 20mph<sup>1</sup>| 0mph           | Toyota            |
+| Toyota               | Camry 2018<sup>4</sup>   | All                  | Yes     | Stock          | 0mph<sup>5</sup> | 0mph           | Toyota            |
+| Toyota               | C-HR 2017-18<sup>4</sup> | All                  | Yes     | Stock          | 0mph             | 0mph           | Toyota            |
+| Toyota               | Corolla 2017-18          | All                  | Yes     | Yes<sup>2</sup>| 20mph<sup>1</sup>| 0mph           | Toyota            |
+| Toyota               | Corolla Hatchback 2019   | All                  | Yes     | Yes            | 0mph             | 0mph           | Toyota            |
+| Toyota               | Highlander 2017-18       | All                  | Yes     | Yes<sup>2</sup>| 0mph             | 0mph           | Toyota            |
+| Toyota               | Highlander Hybrid 2018   | All                  | Yes     | Yes<sup>2</sup>| 0mph             | 0mph           | Toyota            |
+| Toyota               | Prius 2016               | TSS-P                | Yes     | Yes<sup>2</sup>| 0mph             | 0mph           | Toyota            |
+| Toyota               | Prius 2017-19            | All                  | Yes     | Yes<sup>2</sup>| 0mph             | 0mph           | Toyota            |
+| Toyota               | Prius Prime 2017-19      | All                  | Yes     | Yes<sup>2</sup>| 0mph             | 0mph           | Toyota            |
+| Toyota               | Rav4 2016                | TSS-P                | Yes     | Yes<sup>2</sup>| 20mph<sup>1</sup>| 0mph           | Toyota            |
+| Toyota               | Rav4 2017-18             | All                  | Yes     | Yes<sup>2</sup>| 20mph<sup>1</sup>| 0mph           | Toyota            |
+| Toyota               | Rav4 2019                | All                  | Yes     | Yes            | 0mph             | 0mph           | Toyota            |
+| Toyota               | Rav4 Hybrid 2017-18      | All                  | Yes     | Yes<sup>2</sup>| 0mph             | 0mph           | Toyota            |
 
-* **📜 曾榮獲官方認證第一大分支**
+<sup>1</sup>[Comma Pedal](https://community.comma.ai/wiki/index.php/Comma_Pedal) is used to provide stop-and-go capability to some of the openpilot-supported cars that don't currently support stop-and-go. Here is how to [build a Comma Pedal](https://medium.com/@jfrux/comma-pedal-building-with-macrofab-6328bea791e8). ***NOTE: The Comma Pedal is not officially supported by [comma.ai](https://comma.ai)***  
+<sup>2</sup>When disconnecting the Driver Support Unit (DSU), otherwise longitudinal control is stock ACC. For DSU locations, see [Toyota Wiki page](https://community.comma.ai/wiki/index.php/Toyota)  
+<sup>3</sup>[GM installation guide](https://zoneos.com/volt/).  
+<sup>4</sup>It needs an extra 120Ohm resistor ([pic1](https://i.imgur.com/CmdKtTP.jpg), [pic2](https://i.imgur.com/s2etUo6.jpg)) on bus 3 and giraffe switches set to 01X1 (11X1 for stock LKAS), where X depends on if you have the [comma power](https://comma.ai/shop/products/power/).  
+<sup>5</sup>28mph for Camry 4CYL L, 4CYL LE and 4CYL SE which don't have Full-Speed Range Dynamic Radar Cruise Control.  
+<sup>6</sup>Open sourced [Hyundai Giraffe](https://github.com/commaai/neo/tree/master/giraffe/hyundai) is designed for the 2019 Sante Fe; pinout may differ for other Hyundais.  
+<sup>7</sup>Community built Giraffe, find more information [here](https://zoneos.com/shop/).  
 
-  基於活躍的社群與功能創新，`dragonpilot` 曾一度成長為 comma ai 官方認證的第一大 openpilot 分支，這份榮耀屬於每一位參與者。
+Community Maintained Cars
+------
 
-## **🧑‍💻 設計理念 - 少即是多 (Less is More)**
+| Make                 | Model                    | Supported Package    | Lateral | Longitudinal   | No Accel Below   | No Steer Below | Giraffe           |
+| ---------------------| -------------------------| ---------------------| --------| ---------------| -----------------| ---------------|-------------------|
+| Honda                | Fit 2018                 | Honda Sensing        | Yes     | Yes            | 25mph<sup>1</sup>| 12mph          | Inverted Nidec    |
+| Tesla                | Model S 2012-13          | All                  | Yes     | Not yet        | Not applicable   | 0mph           | Custom<sup>8</sup>|
 
-隨著 openpilot 的 AI 模型日益強大，許多過去需要手動微調的功能，現在都已能透過更先進的模型來實現。因此，我們現在的開發重心回歸到 **「最小化修改」(minimal changes)** 的核心原則上。
+[[Honda Fit Pull Request]](https://github.com/commaai/openpilot/pull/266). <br />
+[[Tesla Model S Pull Request]](https://github.com/commaai/openpilot/pull/246) <br />
+<sup>8</sup>Community built Giraffe, find more information here [Community Tesla Giraffe](https://github.com/jeankalud/neo/tree/tesla_giraffe/giraffe/tesla) <br />
 
-我們的目標是為您提供最純粹、最接近官方的 openpilot 駕駛感受，同時保留 `dragonpilot` 那些經過時間考驗、最受社群喜愛的經典功能。我們相信，在強大的 AI 基礎上，簡潔即是力量。
+Community Maintained Cars are not confirmed by comma.ai to meet our [safety model](https://github.com/commaai/openpilot/blob/devel/SAFETY.md). Be extra cautious using them.
 
-## **🛠️ 硬件的足跡 - 一路走來的夥伴們**
+In Progress Cars
+------
+- All TSS-P Toyota with Steering Assist and LSS-P Lexus with Steering Assist or Lane Keep Assist.
+  - Only remaining Toyota cars with no port yet are the Avalon and the Sienna.
+- All Hyundai with SmartSense.
+- All Kia with SCC and LKAS.
+- All Chrysler, Jeep, Fiat with Adaptive Cruise Control and LaneSense.
 
-從最早的 **EON**，到官方的 **comma two / three (C2/C3/C3X)**，再到社群中各式各樣充滿智慧的**副廠機 (如 C1.5, O2, O3, O3L, O3XL 等)**，甚至我們也曾探索過在 [**Jetson Xavier NX**](https://github.com/eFiniLan/xnxpilot) 上的可能性。
+How can I add support for my car?
+------
 
-目前最新版本主要支援： comma3 / 3X 以及 O3 / O3L / O3XL 等社群硬體。
-針對 EON / C1.5 / C2 等舊款硬體，最後支援的版本位於 [d2 分支](https://github.com/dragonpilot-community/dragonpilot/tree/d2)。
-無論您手上是哪一款設備，都代表著您對開源駕駛輔助的一份熱情。
+If your car has adaptive cruise control and lane keep assist, you are in luck. Using a [panda](https://comma.ai/shop/products/panda-obd-ii-dongle/) and [cabana](https://community.comma.ai/cabana/), you can understand how to make your car drive by wire.
 
-## **🫂 加入我們，成為「尋龍者」的一份子**
+We've written guides for [Brand](https://medium.com/@comma_ai/how-to-write-a-car-port-for-openpilot-7ce0785eda84) and [Model](https://medium.com/@comma_ai/openpilot-port-guide-for-toyota-models-e5467f4b5fe6) ports. These guides might help you after you have the basics figured out.
 
-`dragonpilot` 的成長，離不開每一位使用者的貢獻與回饋。我們是一個以**公開、透明**為原則的溫暖社群，希望在這裡能與所有對 openpilot / dragonpilot 有興趣的用戶分享、交流開發與使用上的經驗。
+- BMW, Audi, Volvo, and Mercedes all use [FlexRay](https://en.wikipedia.org/wiki/FlexRay) and can be supported after [FlexRay support](https://github.com/commaai/openpilot/pull/463) is merged.
+- We put time into a Ford port, but the steering has a 10 second cutout limitation that makes it unusable.
+- The 2016-2017 Honda Accord uses a custom signaling protocol for steering that's unlikely to ever be upstreamed.
 
-[**歡迎加入我們的 Facebook 社團進行交流！**](https://www.facebook.com/groups/930190251238639)
+Directory structure
+------
+    .
+    ├── apk                 # The apk files used for the UI
+    ├── cereal              # The messaging spec used for all logs on EON
+    ├── common              # Library like functionality we've developed here
+    ├── installer/updater   # Manages auto-updates of openpilot
+    ├── opendbc             # Files showing how to interpret data from cars
+    ├── panda               # Code used to communicate on CAN and LIN
+    ├── phonelibs           # Libraries used on EON
+    ├── pyextra             # Libraries used on EON
+    └── selfdrive           # Code needed to drive the car
+        ├── assets          # Fonts and images for UI
+        ├── athena          # Allows communication with the app
+        ├── boardd          # Daemon to talk to the board
+        ├── can             # Helpers for parsing CAN messages
+        ├── car             # Car specific code to read states and control actuators
+        ├── common          # Shared C/C++ code for the daemons
+        ├── controls        # Perception, planning and controls
+        ├── debug           # Tools to help you debug and do car ports
+        ├── locationd       # Soon to be home of precise location
+        ├── logcatd         # Android logcat as a service
+        ├── loggerd         # Logger and uploader of car data
+        ├── mapd            # Fetches map data and computes next global path
+        ├── proclogd        # Logs information from proc
+        ├── sensord         # IMU / GPS interface code
+        ├── test            # Car simulator running code through virtual maneuvers
+        ├── ui              # The UI
+        └── visiond         # Vision pipeline
 
-## **❤️ 特別感謝**
+To understand how the services interact, see `selfdrive/service_list.yaml`
 
-`dragonpilot` 從創立至今，從未打算透過 Patreon 等平台進行任何形式的募資。我們的初衷是建立一個讓大家能一起學習、一起成長的社群。It's all about fun, not money.
+User Data / chffr Account / Crash Reporting
+------
 
-然而，我們仍要對那些自發性支持本專案的朋友們，致上最誠摯的感謝。正是因為有您們的鼓勵，我們才有更大的動力持續前進。
+By default, openpilot creates an account and includes a client for chffr, our dashcam app. We use your data to train better models and improve openpilot for everyone.
 
-[**我們的贊助者名單**](SPONSORS.md)
+It's open source software, so you are free to disable it if you wish.
 
-### **安全聲明**
+It logs the road facing camera, CAN, GPS, IMU, magnetometer, thermal sensors, crashes, and operating system logs.
+The user facing camera is only logged if you explicitly opt-in in settings.
+It does not log the microphone.
 
-`dragonpilot` 是一種駕駛**輔助**系統，並非全自動駕駛。它旨在減輕您的駕駛疲勞，提升行車安全，但駕駛人仍需時刻保持專注，並隨時準備接管車輛。請務必遵守您所在地區的交通法規。
+By using it, you agree to [our privacy policy](https://community.comma.ai/privacy.html). You understand that use of this software or its related services will generate certain types of user data, which may be logged and stored at the sole discretion of comma.ai. By accepting this agreement, you grant an irrevocable, perpetual, worldwide right to comma.ai for the use of this data.
 
-**最後，再次感謝您的到來。**
+Testing on PC
+------
 
-**期待與您一同在智慧駕駛的道路上，乘「龍」而行！**
+Check out [openpilot-tools](https://github.com/commaai/openpilot-tools): lots of tools you can use to replay driving data, test and develop openpilot from your pc.
+
+Also, within openpilot there is a rudimentary infrastructure to run a basic simulation and generate a report of openpilot's behavior in different longitudinal control scenarios.
+
+```bash
+# Requires working docker
+./run_docker_tests.sh
+```
+
+Contributing
+------
+
+We welcome both pull requests and issues on [github](http://github.com/commaai/openpilot). Bug fixes and new car ports encouraged.
+
+We also have a [bounty program](https://comma.ai/bounties.html).
+
+Want to get paid to work on openpilot? [comma.ai is hiring](https://comma.ai/jobs/)
+
+Licensing
+------
+
+openpilot is released under the MIT license. Some parts of the software are released under other licenses as specified.
+
+Any user of this software shall indemnify and hold harmless Comma.ai, Inc. and its directors, officers, employees, agents, stockholders, affiliates, subcontractors and customers from and against all allegations, claims, actions, suits, demands, damages, liabilities, obligations, losses, settlements, judgments, costs and expenses (including without limitation attorneys’ fees and costs) which arise out of, relate to or result from any use of this software by user.
+
+**THIS IS ALPHA QUALITY SOFTWARE FOR RESEARCH PURPOSES ONLY. THIS IS NOT A PRODUCT.
+YOU ARE RESPONSIBLE FOR COMPLYING WITH LOCAL LAWS AND REGULATIONS.
+NO WARRANTY EXPRESSED OR IMPLIED.**
+
+---
+
+<img src="https://d1qb2nb5cznatu.cloudfront.net/startups/i/1061157-bc7e9bf3b246ece7322e6ffe653f6af8-medium_jpg.jpg?buster=1458363130" width="75"></img> <img src="https://cdn-images-1.medium.com/max/1600/1*C87EjxGeMPrkTuVRVWVg4w.png" width="225"></img>

README_EN.md

@@ -1,74 +0,0 @@
-![](dragonpilot/selfdrive/assets/dragonpilot.png)
-
-[Read this in Chinese](README.md)
-
-# **🐲 dragonpilot - Bringing the Spirit of the Dragon to Your Car**
-
-**Join us on a smarter, more thoughtful driving journey.**
-
-## **👋 Welcome, friend!**
-
-`dragonpilot` was launched in 2019 by three early openpilot enthusiasts from the Chinese community. Our mission was simple: create a friendly space for users to share experiences, provide easier setup help, and add features tailored for local needs.
-
-Localization has always been at the heart of what we do—starting with a fully Chinese interface. This made `dragonpilot` quickly popular in Chinese-speaking regions and helped our user base grow into one of the largest worldwide. That community support is what keeps us moving forward.
-
-Built on top of the powerful [openpilot](https://github.com/commaai/openpilot)—an open-source driver assistance system rated by Consumer Reports as outperforming commercial offerings—we add localized refinements and user-focused features to create a driving companion that truly fits your needs. (You can also see the [original openpilot README](README_OPENPILOT.md) preserved in our repo.)
-
-The name `dragonpilot` reflects our vision: like the dragon of mythology, it is strong and wise, guarding your safety on the road. In Chinese culture, the dragon is also a symbol of luck and strength, representing our roots and pride.
-
-## **✨ Milestones**
-
-Beyond carrying forward openpilot's core strengths, we've reached several milestones inspired by community feedback:
-
-* **🚘 Always Lane Keep Assist (ALKA)**
-
-  More than a feature—it's part of the `dragonpilot` philosophy. Introduced as early as [version 0.6.2](https://github.com/dragonpilot-community/dragonpilot/blob/2861467183d62151024320447ba04d18fc3fe1e6/selfdrive/car/toyota/carstate.py#L199), first tested on a 2017 Lexus IS300h, then expanded to Toyota's lineup and beyond. ALKA helps keep your vehicle steadily centered, giving you extra confidence on the road.
-
-* **🌐 First to add multilingual support**
-
-  Before openpilot officially supported it, we had already introduced multiple languages. `dragonpilot` fully supports Traditional Chinese, Simplified Chinese, and English.
-
-* **💻 Only community fork to support multiple hardware platforms at once**
-
-  We uniquely worked to make the project run on EON, comma two, comma 3, and Jetson—serving the widest range of users possible.
-  Additionally, after the comma.ai team deprecated the comma 3 in version 0.10.0, we remain the only community fork to offer full, simultaneous support for the comma 3, comma 3X, and the O3, O3L, and O3XL (the O3 series being third-party hardware).
-
-* **📜 Once recognized as the #1 openpilot fork**
-
-  Thanks to an active community and continuous innovation, `dragonpilot` was once the largest openpilot fork officially recognized by comma ai. This honor belongs to everyone who contributed.
-
-## **🧑‍💻 Design Philosophy - Less is More**
-
-As openpilot's AI grows stronger, many features that once required manual tuning are now handled by advanced models. That's why our focus has returned to **“minimal changes.”**
-
-We aim to give you the purest, most official-like openpilot driving experience—while preserving `dragonpilot`'s classic, community-loved features. With a solid AI foundation, simplicity is strength.
-
-## **🛠️ Hardware Journey**
-
-From the early **EON**, to official devices like **comma two / three (C2/C3/C3X)**, to creative community builds (**C1.5, O2, O3, O3L, O3XL, etc.**), and even experiments with [**Jetson Xavier NX**](https://github.com/eFiniLan/xnxpilot).
-
-Currently, the latest versions support: **comma3 / 3X** and community hardware like **O3 / O3L / O3XL**.
-Older devices such as **EON / C1.5 / C2** are supported in the [d2 branch](https://github.com/dragonpilot-community/dragonpilot/tree/d2).
-Whatever device you're on, it represents your passion for open-source driver assistance.
-
-## **🫂 Join Us – Become a “Dragon Seeker”**
-
-`dragonpilot` thrives thanks to every user's contributions and feedback. We're an open, transparent, and welcoming community where enthusiasts can share experiences with openpilot and `dragonpilot`.
-
-[**Join our Facebook group here!**](https://www.facebook.com/groups/930190251238639)
-
-## **❤️ Special Thanks**
-
-Since day one, `dragonpilot` has never asked for funding through Patreon or similar platforms. Our vision is a community where everyone learns and grows together. It's about fun, not money.
-
-That said, we're deeply grateful to those who voluntarily supported the project. Your encouragement keeps us motivated to keep building.
-
-[**See our sponsors**](SPONSORS.md)
-
-### **Safety Notice**
-
-`dragonpilot` is a driver **assistance** system, not full self-driving. It reduces fatigue and improves safety, but you must remain alert and ready to take control at all times. Always follow your local traffic laws.
-
-**Thanks again for being here.**
-
-**We look forward to riding the “dragon” with you on the road to smarter driving!**

README_OPENPILOT.md

@@ -1,111 +0,0 @@
-<div align="center" style="text-align: center;">
-
-<h1>openpilot</h1>
-
-<p>
-  <b>openpilot is an operating system for robotics.</b>
-  <br>
-  Currently, it upgrades the driver assistance system in 300+ supported cars.
-</p>
-
-<h3>
-  <a href="https://docs.comma.ai">Docs</a>
-  <span> · </span>
-  <a href="https://docs.comma.ai/contributing/roadmap/">Roadmap</a>
-  <span> · </span>
-  <a href="https://github.com/commaai/openpilot/blob/master/docs/CONTRIBUTING.md">Contribute</a>
-  <span> · </span>
-  <a href="https://discord.comma.ai">Community</a>
-  <span> · </span>
-  <a href="https://comma.ai/shop">Try it on a comma 3X</a>
-</h3>
-
-Quick start: `bash <(curl -fsSL openpilot.comma.ai)`
-
-[![openpilot tests](https://github.com/commaai/openpilot/actions/workflows/tests.yaml/badge.svg)](https://github.com/commaai/openpilot/actions/workflows/tests.yaml)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
-[![X Follow](https://img.shields.io/twitter/follow/comma_ai)](https://x.com/comma_ai)
-[![Discord](https://img.shields.io/discord/469524606043160576)](https://discord.comma.ai)
-
-</div>
-
-<table>
-  <tr>
-    <td><a href="https://youtu.be/NmBfgOanCyk" title="Video By Greer Viau"><img src="https://github.com/commaai/openpilot/assets/8762862/2f7112ae-f748-4f39-b617-fabd689c3772"></a></td>
-    <td><a href="https://youtu.be/VHKyqZ7t8Gw" title="Video By Logan LeGrand"><img src="https://github.com/commaai/openpilot/assets/8762862/92351544-2833-40d7-9e0b-7ef7ae37ec4c"></a></td>
-    <td><a href="https://youtu.be/SUIZYzxtMQs" title="A drive to Taco Bell"><img src="https://github.com/commaai/openpilot/assets/8762862/05ceefc5-2628-439c-a9b2-89ce77dc6f63"></a></td>
-  </tr>
-</table>
-
-
-Using openpilot in a car
-------
-
-To use openpilot in a car, you need four things:
-1. **Supported Device:** a comma 3X, available at [comma.ai/shop](https://comma.ai/shop/comma-3x).
-2. **Software:** The setup procedure for the comma 3X allows users to enter a URL for custom software. Use the URL `openpilot.comma.ai` to install the release version.
-3. **Supported Car:** Ensure that you have one of [the 275+ supported cars](docs/CARS.md).
-4. **Car Harness:** You will also need a [car harness](https://comma.ai/shop/car-harness) to connect your comma 3X to your car.
-
-We have detailed instructions for [how to install the harness and device in a car](https://comma.ai/setup). Note that it's possible to run openpilot on [other hardware](https://blog.comma.ai/self-driving-car-for-free/), although it's not plug-and-play.
-
-
-### Branches
-
-Running `master` and other branches directly is supported, but it's recommended to run one of the following prebuilt branches:
-
-| comma four branch      | comma 3X branch        | URL                                    | description                                                                         |
-|------------------------|------------------------|----------------------------------------|-------------------------------------------------------------------------------------|
-| `release-mici`         | `release-tizi`         | openpilot.comma.ai                     | This is openpilot's release branch.                                                 |
-| `release-mici-staging` | `release-tizi-staging` | openpilot-test.comma.ai                | This is the staging branch for releases. Use it to get new releases slightly early. |
-| `nightly`              | `nightly`              | openpilot-nightly.comma.ai             | This is the bleeding edge development branch. Do not expect this to be stable.      |
-| `nightly-dev`          | `nightly-dev`          | installer.comma.ai/commaai/nightly-dev | Same as nightly, but includes experimental development features for some cars.      |
-
-To start developing openpilot
-------
-
-openpilot is developed by [comma](https://comma.ai/) and by users like you. We welcome both pull requests and issues on [GitHub](http://github.com/commaai/openpilot).
-
-* Join the [community Discord](https://discord.comma.ai)
-* Check out [the contributing docs](docs/CONTRIBUTING.md)
-* Check out the [openpilot tools](tools/)
-* Code documentation lives at https://docs.comma.ai
-* Information about running openpilot lives on the [community wiki](https://github.com/commaai/openpilot/wiki)
-
-Want to get paid to work on openpilot? [comma is hiring](https://comma.ai/jobs#open-positions) and offers lots of [bounties](https://comma.ai/bounties) for external contributors.
-
-Safety and Testing
-----
-
-* openpilot observes [ISO26262](https://en.wikipedia.org/wiki/ISO_26262) guidelines, see [SAFETY.md](docs/SAFETY.md) for more details.
-* openpilot has software-in-the-loop [tests](.github/workflows/tests.yaml) that run on every commit.
-* The code enforcing the safety model lives in panda and is written in C, see [code rigor](https://github.com/commaai/panda#code-rigor) for more details.
-* panda has software-in-the-loop [safety tests](https://github.com/commaai/panda/tree/master/tests/safety).
-* Internally, we have a hardware-in-the-loop Jenkins test suite that builds and unit tests the various processes.
-* panda has additional hardware-in-the-loop [tests](https://github.com/commaai/panda/blob/master/Jenkinsfile).
-* We run the latest openpilot in a testing closet containing 10 comma devices continuously replaying routes.
-
-<details>
-<summary>MIT Licensed</summary>
-
-openpilot is released under the MIT license. Some parts of the software are released under other licenses as specified.
-
-Any user of this software shall indemnify and hold harmless Comma.ai, Inc. and its directors, officers, employees, agents, stockholders, affiliates, subcontractors and customers from and against all allegations, claims, actions, suits, demands, damages, liabilities, obligations, losses, settlements, judgments, costs and expenses (including without limitation attorneys’ fees and costs) which arise out of, relate to or result from any use of this software by user.
-
-**THIS IS ALPHA QUALITY SOFTWARE FOR RESEARCH PURPOSES ONLY. THIS IS NOT A PRODUCT.
-YOU ARE RESPONSIBLE FOR COMPLYING WITH LOCAL LAWS AND REGULATIONS.
-NO WARRANTY EXPRESSED OR IMPLIED.**
-</details>
-
-<details>
-<summary>User Data and comma Account</summary>
-
-By default, openpilot uploads the driving data to our servers. You can also access your data through [comma connect](https://connect.comma.ai/). We use your data to train better models and improve openpilot for everyone.
-
-openpilot is open source software: the user is free to disable data collection if they wish to do so.
-
-openpilot logs the road-facing cameras, CAN, GPS, IMU, magnetometer, thermal sensors, crashes, and operating system logs.
-The driver-facing camera and microphone are only logged if you explicitly opt-in in settings.
-
-By using openpilot, you agree to [our Privacy Policy](https://comma.ai/privacy). You understand that use of this software or its related services will generate certain types of user data, which may be logged and stored at the sole discretion of comma. By accepting this agreement, you grant an irrevocable, perpetual, worldwide right to comma for the use of this data.
-</details>

README_chffrplus.md

@@ -0,0 +1,36 @@
+Welcome to chffrplus
+======
+
+[chffrplus](https://github.com/commaai/chffrplus) is an open source dashcam.
+
+This is the shipping reference software for the comma EON Dashcam DevKit. It keeps many of the niceities of [openpilot](https://github.com/commaai/openpilot), like high quality sensors, great camera, and good autostart and stop. Though unlike openpilot, it cannot control your car. chffrplus can interface with your car through a [panda](https://shop.comma.ai/products/panda-obd-ii-dongle), but just like our dashcam app [chffr](https://getchffr.com/), it is read only.
+
+It integrates with the rest of the comma ecosystem, so you can view your drives on the [chffr](https://getchffr.com/) app for Android or iOS, and reverse engineer your car with [cabana](https://community.comma.ai/cabana/?demo=1).
+
+
+Hardware
+------
+
+Right now chffrplus supports the [EON Dashcam DevKit](https://shop.comma.ai/products/eon-dashcam-devkit) for hardware to run on.
+
+Install chffrplus on a EON device by entering ``https://chffrplus.comma.ai`` during NEOS setup.
+
+
+User Data / chffr Account / Crash Reporting
+------
+
+By default chffrplus creates an account and includes a client for chffr, our dashcam app.
+
+It's open source software, so you are free to disable it if you wish. 
+
+It logs the road facing camera, CAN, GPS, IMU, magnetometer, thermal sensors, crashes, and operating system logs.
+It does not log the user facing camera or the microphone.
+
+By using it, you agree to [our privacy policy](https://beta.comma.ai/privacy.html). You understand that use of this software or its related services will generate certain types of user data, which may be logged and stored at the sole discretion of comma.ai. By accepting this agreement, you grant an irrevocable, perpetual, worldwide right to comma.ai for the use of this data.
+
+
+Licensing
+------
+
+chffrplus is released under the MIT license.
+

RELEASES.md

@@ -1,727 +1,3 @@
-Version 0.11.0 (2026-03-17)
-========================
-* New driving model #36798
-  * Fully trained using a learned simulator
-  * Improved longitudinal performance in Experimental mode
-* Reduce comma four standby power usage by 77% to 52 mW
-* Kia K7 2017 support thanks to royjr!
-* Lexus LS 2018 support thanks to Hacheoy!
-
-Version 0.10.3 (2025-12-17)
-========================
-* New driving model #36249
-  * New temporal policy architecture
-  * New on-policy training physics noise model
-* New driver monitoring model #36409
-  * Trained on a new dataset, including comma four data
-* Improved inter-process communication memory efficiency
-
-Version 0.10.2 (2025-11-19)
-========================
-* comma four support
-
-Version 0.10.1 (2025-09-08)
-========================
-* New driving model #36276
-  * World Model: removed global localization inputs
-  * World Model: 2x the number of parameters
-  * World Model: trained on 4x the number of segments
-  * VAE Compression Model: new architecture and training objective
-  * Driving Vision Model: trained on 4x the number of segments
-* New Driver Monitoring model #36198
-* Acura TLX 2021 support thanks to MVL!
-* Honda City 2023 support thanks to vanillagorillaa and drFritz!
-* Honda N-Box 2018 support thanks to miettal!
-* Honda Odyssey 2021-25 support thanks to csouers and MVL!
-* Honda Passport 2026 support thanks to vanillagorillaa and MVL!
-
-Version 0.10.0 (2025-08-05)
-========================
-* New driving model
-  * New training architecture
-     * Described in our CVPR paper: "Learning to Drive from a World Model"
-     * Longitudinal MPC replaced by E2E planning from World Model in Experimental Mode
-     * Action from lateral MPC as training objective replaced by E2E planning from World Model
-  * Low-speed lead car ground-truth fixes
-* Enable live-learned steering actuation delay
-* Opt-in audio recording for dashcam video
-* Acura MDX 2025 support thanks to vanillagorillaa and MVL!
-* Honda Accord 2023-25 support thanks to vanillagorillaa and MVL!
-* Honda CR-V 2023-25 support thanks to vanillagorillaa and MVL!
-* Honda Pilot 2023-25 support thanks to vanillagorillaa and MVL!
-
-Version 0.9.9 (2025-05-23)
-========================
-* New driving model
-  * New training architecture using parts from MLSIM
-* Steering actuation delay is now learned online
-* Ford Escape 2023-24 support thanks to incognitojam!
-* Ford Kuga 2024 support thanks to incognitojam!
-* Hyundai Nexo 2021 support thanks to sunnyhaibin!
-* Tesla Model 3 and Y support thanks to lukasloetkolben!
-* Lexus RC 2023 support thanks to nelsonjchen!
-
-Version 0.9.8 (2025-02-28)
-========================
-* New driving model
-  * Model now gates applying positive acceleration in Chill mode
-* New driver monitoring model
-  * Reduced false positives related to passengers
-* Image processing pipeline moved to the ISP
-  * More GPU time for bigger driving models
-  * Power draw reduced 0.5W, which means your device runs cooler
-* Added toggle to enable driver monitoring even when openpilot is not engaged
-* Localizer rewritten to remove GPS dependency at runtime
-* Firehose Mode for maximizing your training data uploads
-* Enable openpilot longitudinal control for Ford Q3 vehicles
-* New Toyota TSS2 longitudinal tune
-* Rivian R1S and R1T support thanks to lukasloetkolben!
-* Ford F-150, F-150 Hybrid, Mach-E, and Ranger support
-
-Version 0.9.7 (2024-06-13)
-========================
-* New driving model
-  * Inputs the past curvature for smoother and more accurate lateral control
-  * Simplified neural network architecture in the model's last layers
-  * Minor fixes to desire augmentation and weight decay
-* New driver monitoring model
-  * Improved end-to-end bit for phone detection
-* Adjust driving personality with the follow distance button
-* Support for hybrid variants of supported Ford models
-* Fingerprinting without the OBD-II port on all cars
-* Improved fuzzy fingerprinting for Ford and Volkswagen
-
-Version 0.9.6 (2024-02-27)
-========================
-* New driving model
-  * Vision model trained on more data
-  * Improved driving performance
-  * Directly outputs curvature for lateral control
-* New driver monitoring model
-  * Trained on larger dataset
-* Model path UI
-  * Shows where driving model wants to be
-  * Shows what model is seeing more clearly, but more jittery
-* AGNOS 9
-* comma body streaming and controls over WebRTC
-* Improved fuzzy fingerprinting for many makes and models
-* Alpha longitudinal support for new Toyota models
-* Chevrolet Equinox 2019-22 support thanks to JasonJShuler and nworb-cire!
-* Dodge Durango 2020-21 support
-* Hyundai Staria 2023 support thanks to sunnyhaibin!
-* Kia Niro Plug-in Hybrid 2022 support thanks to sunnyhaibin!
-* Lexus LC 2024 support thanks to nelsonjchen!
-* Toyota RAV4 2023-24 support
-* Toyota RAV4 Hybrid 2023-24 support
-
-Version 0.9.5 (2023-11-17)
-========================
-* New driving model
-  * Improved navigate on openpilot performance using navigation instructions as an additional model input
-  * Do lateral planning inside the model
-  * New vision transformer architecture
-* Cadillac Escalade ESV 2019 support thanks to twilsonco!
-* Hyundai Azera 2022 support thanks to sunnyhaibin!
-* Hyundai Azera Hybrid 2020 support thanks to chanhojung and haram-KONA!
-* Hyundai Custin 2023 support thanks to sunnyhaibin and Saber422!
-* Hyundai Ioniq 6 2023 support thanks to sunnyhaibin and alamo3!
-* Hyundai Kona Electric 2023 (Korean version) support thanks to sunnyhaibin and haram-KONA!
-* Kia K8 Hybrid (with HDA II) 2023 support thanks to sunnyhaibin!
-* Kia Optima Hybrid 2019 support
-* Kia Sorento Hybrid 2023 support thanks to sunnyhaibin!
-* Lexus GS F 2016 support thanks to snyperifle!
-* Lexus IS 2023 support thanks to L3R5!
-
-Version 0.9.4 (2023-07-27)
-========================
-* comma 3X support
-* Navigate on openpilot in Experimental mode
-  * When navigation has a destination, openpilot will input the map information into the model, which provides useful context to help the model understand the scene
-  * When navigating on openpilot, openpilot will keep left or right appropriately at forks and exits
-  * When navigating on openpilot, lane change behavior is unchanged and still activated by the driver
-  * When navigate on openpilot is active, the path on the map is green
-* UI updates
-  * Navigation settings moved to home screen and map
-  * Border color always shows engagement status. Blue means disengaged, green means engaged, and grey means engaged with human overriding
-  * Alerts are shown inside the border. Black means info, orange means warning, and red means critical alert
-* Bookmarked segments are preserved on the device's storage
-* Ford Focus 2018 support
-* Kia Carnival 2023 support thanks to sunnyhaibin!
-
-Version 0.9.3 (2023-06-29)
-========================
-* New driving model
-  * Improved height estimation and added height tracking in liveCalibration
-  * Model inputs refactor
-* New driving personality setting
-  * Three settings: aggressive, standard, and relaxed
-  * Standard is recommended and the default
-  * In aggressive mode, lead follow distance is shorter and acceleration response is quicker
-  * In relaxed mode, lead follow distance is longer
-* Improved fuzzy fingerprinting for Hyundai, Kia, and Genesis
-* Improved thermal management logic
-
-Version 0.9.2 (2023-05-22)
-========================
-* New driving model
-  * Reduced turn diving
-  * Trained on a new dataset
-* UI updates
-  * New experimental mode visualization
-  * Draw MPC path instead of model-predicted path
-* AGNOS 7
-  * Faster boot time
-  * Fixes rare no sounds bug
-  * Fixes bootsplash bug at extreme temperatures
-* Buick LaCrosse 2017-19 support thanks to koch-cf!
-* Chevrolet Trailblazer 2021-22 support thanks to TurboCE!
-* Ford Bronco Sport 2021-22 support
-* Ford Escape 2020-22 support
-* Ford Explorer 2020-22 support
-* Ford Kuga 2020-22 support
-* Ford Maverick 2022-23 support
-* Genesis GV80 2023 support thanks to JWingate80!
-* Honda HR-V 2023 support thanks to AlexandreSato and galegozi!
-* Kia Niro EV 2023 support thanks to JosselinLecocq!
-* Lexus ES 2017-18 support
-* Lincoln Aviator 2021 support
-* Škoda Fabia 2022-23 support thanks to jyoung8607!
-
-
-Version 0.9.1 (2023-02-28)
-========================
-* New driving model
-  * 30% improved height estimation resulting in better driving performance for tall cars
-* Driver monitoring: removed timer resetting on user interaction if distracted
-* UI updates
-  * Adjust alert volume using ambient noise level
-  * Driver monitoring icon shows driver's head pose
-  * German translation thanks to Vrabetz and CzokNorris!
-* Cadillac Escalade 2017 support thanks to rickygilleland!
-* Chevrolet Bolt EV 2022-23 support thanks to JasonJShuler!
-* Genesis GV60 2023 support thanks to sunnyhaibin!
-* Hyundai Tucson 2022-23 support
-* Kia K5 Hybrid 2020 support thanks to sunnyhaibin!
-* Kia Niro Hybrid 2023 support thanks to sunnyhaibin!
-* Kia Sorento 2022-23 support thanks to sunnyhaibin!
-* Kia Sorento Plug-in Hybrid 2022 support thanks to sunnyhaibin!
-* Toyota C-HR 2021 support thanks to eFiniLan!
-* Toyota C-HR Hybrid 2022 support thanks to Korben00!
-* Volkswagen Crafter and MAN TGE 2017-23 support thanks to jyoung8607!
-
-Version 0.9.0 (2022-11-21)
-========================
-* New driving model
-  * Internal feature space information content increased tenfold during training to ~700 bits, which makes the model dramatically more accurate
-  * Less reliance on previous frames makes model more reactive and snappy
-  * Trained in new reprojective simulator
-  * Trained in 36 hours from scratch, compared to one week for previous releases
-  * Training now simulates both lateral and longitudinal behavior, which allows openpilot to slow down for turns, stop at traffic lights, and more in experimental mode
-* Experimental driving mode
-  * End-to-end longitudinal control
-  * Stops for traffic lights and stop signs
-  * Slows down for turns
-  * openpilot defaults to chill mode, enable experimental mode in settings
-* Driver monitoring updates
-  * New bigger model with added end-to-end distracted trigger
-  * Reduced false positives during driver calibration
-* Self-tuning torque controller: learns parameters live for each car
-* Torque controller used on all Toyota, Lexus, Hyundai, Kia, and Genesis models
-* UI updates
-  * Matched speeds shown on car's dash
-  * Multi-language in navigation
-  * Improved update experience
-  * Border turns grey while overriding steering
-  * Bookmark events while driving; view them in comma connect
-  * New onroad visualization for experimental mode
-* tools: new and improved cabana thanks to deanlee!
-* Experimental longitudinal support for Volkswagen, CAN-FD Hyundai, and new GM models
-* Genesis GV70 2022-23 support thanks to zunichky and sunnyhaibin!
-* Hyundai Santa Cruz 2021-22 support thanks to sunnyhaibin!
-* Kia Sportage 2023 support thanks to sunnyhaibin!
-* Kia Sportage Hybrid 2023 support thanks to sunnyhaibin!
-* Kia Stinger 2022 support thanks to sunnyhaibin!
-
-Version 0.8.16 (2022-08-26)
-========================
-* New driving model
-  * Reduced turn cutting
-* Auto-detect right hand drive setting with driver monitoring model
-* Improved fan controller for comma three
-* New translations
-  * Japanese thanks to cydia2020!
-  * Brazilian Portuguese thanks to AlexandreSato!
-* Chevrolet Bolt EUV 2022-23 support thanks to JasonJShuler!
-* Chevrolet Silverado 1500 2020-21 support thanks to JasonJShuler!
-* GMC Sierra 1500 2020-21 support thanks to JasonJShuler!
-* Hyundai Ioniq 5 2022 support thanks to sunnyhaibin!
-* Hyundai Kona Electric 2022 support thanks to sunnyhaibin!
-* Hyundai Tucson Hybrid 2022 support thanks to sunnyhaibin!
-* Subaru Legacy 2020-22 support thanks to martinl!
-* Subaru Outback 2020-22 support
-
-Version 0.8.15 (2022-07-20)
-========================
-* New driving model
-  * Path planning uses end-to-end output instead of lane lines at all times
-  * Reduced ping pong
-  * Improved lane centering
-* New lateral controller based on physical wheel torque model
-  * Much smoother control that's consistent across the speed range
-  * Effective feedforward that uses road roll
-  * Simplified tuning, all car-specific parameters can be derived from data
-  * Used on select Toyota and Hyundai models at first
-  * Significantly improved control on TSS-P Prius
-* New driver monitoring model
-  * Bigger model, covering full interior view from driver camera
-  * Works with a wider variety of mounting angles
-  * 3x more unique comma three training data than previous
-* Navigation improvements
-  * Speed limits shown while navigating
-  * Faster position fix by using raw GPS measurements
-* UI updates
-  * Multilanguage support for settings and home screen
-  * New font
-  * Refreshed max speed design
-  * More consistent camera view perspective across cars
-* Reduced power usage: device runs cooler and fan spins less
-* AGNOS 5
-  * Support VSCode remote SSH target
-  * Support for delta updates to reduce data usage on future OS updates
-* Chrysler ECU firmware fingerprinting thanks to realfast!
-* Honda Civic 2022 support
-* Hyundai Tucson 2021 support thanks to bluesforte!
-* Kia EV6 2022 support
-* Lexus NX Hybrid 2020 support thanks to AlexandreSato!
-* Ram 1500 2019-21 support thanks to realfast!
-
-Version 0.8.14 (2022-06-01)
-========================
- * New driving model
-   * Bigger model, using both of comma three's road-facing cameras
-   * Better at cut-in detection and tight turns
- * New driver monitoring model
-   * Tweaked network structure to improve output resolution for DSP
-   * Fixed bug in quantization aware training to reduce quantizing errors
-   * Resulted in 7x less MSE and no more random biases at runtime
- * Added toggle to disable disengaging on the accelerator pedal
- * comma body support
- * Audi RS3 support thanks to jyoung8607!
- * Hyundai Ioniq Plug-in Hybrid 2019 support thanks to sunnyhaibin!
- * Hyundai Tucson Diesel 2019 support thanks to sunnyhaibin!
- * Toyota Alphard Hybrid 2021 support
- * Toyota Avalon Hybrid 2022 support
- * Toyota RAV4 2022 support
- * Toyota RAV4 Hybrid 2022 support
-
-Version 0.8.13 (2022-02-18)
-========================
- * Improved driver monitoring
-   * Re-tuned driver pose learner for relaxed driving positions
-   * Added reliance on driving model to be more scene adaptive
-   * Matched strictness between comma two and comma three
- * Improved performance in turns by compensating for the road bank angle
- * Improved camera focus on the comma two
- * AGNOS 4
-   * ADB support
-   * improved cell auto configuration
- * NEOS 19
-   * package updates
-   * stability improvements
- * Subaru ECU firmware fingerprinting thanks to martinl!
- * Hyundai Santa Fe Plug-in Hybrid 2022 support thanks to sunnyhaibin!
- * Mazda CX-5 2022 support thanks to Jafaral!
- * Subaru Impreza 2020 support thanks to martinl!
- * Toyota Avalon 2022 support thanks to sshane!
- * Toyota Prius v 2017 support thanks to CT921!
- * Volkswagen Caravelle 2020 support thanks to jyoung8607!
-
-Version 0.8.12 (2021-12-15)
-========================
- * New driving model
-   * Improved behavior around exits
-   * Better pose accuracy at high speeds, allowing max speed of 90mph
-   * Fully incorporated comma three data into all parts of training stack
- * Improved follow distance
- * Better longitudinal policy, especially in low speed traffic
- * New alert sounds
- * AGNOS 3
-   * Display burn in mitigation
-   * Improved audio amplifier configuration
-   * System reliability improvements
-   * Update Python to 3.8.10
- * Raw logs upload moved to connect.comma.ai
- * Fixed HUD alerts on newer Honda Bosch thanks to csouers!
- * Audi Q3 2020-21 support thanks to jyoung8607!
- * Lexus RC 2020 support thanks to ErichMoraga!
-
-Version 0.8.11 (2021-11-29)
-========================
- * Support for CAN FD on the red panda
- * Support for an external panda on the comma three
- * Navigation: Show more detailed instructions when approaching maneuver
- * Fixed occasional steering faults on GM cars thanks to jyoung8607!
- * Nissan ECU firmware fingerprinting thanks to robin-reckmann, martinl, and razem-io!
- * Cadillac Escalade ESV 2016 support thanks to Gibby!
- * Genesis G70 2020 support thanks to tecandrew!
- * Hyundai Santa Fe Hybrid 2022 support thanks to sunnyhaibin!
- * Mazda CX-9 2021 support thanks to Jacar!
- * Volkswagen Polo 2020 support thanks to jyoung8607!
- * Volkswagen T-Roc 2021 support thanks to jyoung8607!
-
-Version 0.8.10 (2021-11-01)
-========================
- * New driving model
-   * Trained on one million minutes!!!
-   * Fixed lead training making lead predictions significantly more accurate
-   * Fixed several localizer dataset bugs and loss function bugs, overall improved accuracy
- * New driver monitoring model
-   * Trained on latest data from both comma two and comma three
-   * Increased model field of view by 40% on comma three
-   * Improved model stability on masked users
-   * Improved pose prediction with reworked ground-truth stack
- * Lateral and longitudinal planning MPCs now in ACADOS
- * Combined longitudinal MPCs
-   * All longitudinal planning now happens in a single MPC system
-   * Fixed instability in MPC problem to prevent sporadic CPU usage
- * AGNOS 2: minor stability improvements and builder repo open sourced
- * tools: new and improved replay thanks to deanlee!
- * Moved community-supported cars outside of the Community Features toggle
- * Improved FW fingerprinting reliability for Hyundai/Kia/Genesis
- * Added prerequisites for longitudinal control on Hyundai/Kia/Genesis and Honda Bosch
- * Audi S3 2015 support thanks to jyoung8607!
- * Honda Freed 2020 support thanks to belm0!
- * Hyundai Ioniq Hybrid 2020-2022 support thanks to sunnyhaibin!
- * Hyundai Santa Fe 2022 support thanks to sunnyhaibin!
- * Kia K5 2021 support thanks to sunnyhaibin!
- * Škoda Kamiq 2021 support thanks to jyoung8607!
- * Škoda Karoq 2019 support thanks to jyoung8607!
- * Volkswagen Arteon 2021 support thanks to jyoung8607!
- * Volkswagen California 2021 support thanks to jyoung8607!
- * Volkswagen Taos 2022 support thanks to jyoung8607!
-
-Version 0.8.9 (2021-09-14)
-========================
- * Improved fan control on comma three
- * AGNOS 1.5: improved stability
- * Honda e 2020 support
-
-Version 0.8.8 (2021-08-27)
-========================
- * New driving model with improved laneless performance
-   * Trained on 5000+ hours of diverse driving data from 3000+ users in 40+ countries
-   * Better anti-cheating methods during simulator training ensure the model hugs less when in laneless mode
-   * All new desire ground-truthing stack makes the model better at lane changes
- * New driver monitoring model: improved performance on comma three
- * NEOS 18 for comma two: update packages
- * AGNOS 1.3 for comma three: fix display init at high temperatures
- * Improved auto-exposure on comma three
- * Improved longitudinal control on Honda Nidec cars
- * Hyundai Kona Hybrid 2020 support thanks to haram-KONA!
- * Hyundai Sonata Hybrid 2021 support thanks to Matt-Wash-Burn!
- * Kia Niro Hybrid 2021 support thanks to tetious!
-
-Version 0.8.7 (2021-07-31)
-========================
- * comma three support!
- * Navigation alpha for the comma three!
- * Volkswagen T-Cross 2021 support thanks to jyoung8607!
-
-Version 0.8.6 (2021-07-21)
-========================
- * Revamp lateral and longitudinal planners
-   * Refactor planner output API to be more readable and verbose
-   * Planners now output desired trajectories for speed, acceleration, curvature, and curvature rate
-   * Use MPC for longitudinal planning when no lead car is present, makes accel and decel smoother
- * Remove "CHECK DRIVER FACE VISIBILITY" warning
- * Fixed cruise fault on some TSS2.5 Camrys and international Toyotas
- * Hyundai Elantra Hybrid 2021 support thanks to tecandrew!
- * Hyundai Ioniq PHEV 2020 support thanks to YawWashout!
- * Kia Niro Hybrid 2019 support thanks to jyoung8607!
- * Škoda Octavia RS 2016 support thanks to jyoung8607!
- * Toyota Alphard 2020 support thanks to belm0!
- * Volkswagen Golf SportWagen 2015 support thanks to jona96!
- * Volkswagen Touran 2017 support thanks to jyoung8607!
-
-Version 0.8.5 (2021-06-11)
-========================
- * NEOS update: improved reliability and stability with better voltage regulator configuration
- * Smart model-based Forward Collision Warning
- * CAN-based fingerprinting moved behind community features toggle
- * Improved longitudinal control on Toyotas with a comma pedal
- * Improved auto-brightness using road-facing camera
- * Added "Software" settings page with updater controls
- * Audi Q2 2018 support thanks to jyoung8607!
- * Hyundai Elantra 2021 support thanks to CruiseBrantley!
- * Lexus UX Hybrid 2019-2020 support thanks to brianhaugen2!
- * Toyota Avalon Hybrid 2019 support thanks to jbates9011!
- * SEAT Leon 2017 & 2020 support thanks to jyoung8607!
- * Škoda Octavia 2015 & 2019 support thanks to jyoung8607!
-
-Version 0.8.4 (2021-05-17)
-========================
- * Delay controls start until system is ready
- * Fuzzy car identification, enabled with Community Features toggle
- * Localizer optimized for increased precision and less CPU usage
- * Re-tuned lateral control to be more aggressive when model is confident
- * Toyota Mirai 2021 support
- * Lexus NX 300 2020 support thanks to goesreallyfast!
- * Volkswagen Atlas 2018-19 support thanks to jyoung8607!
-
-Version 0.8.3 (2021-04-01)
-========================
- * New model
-   * Trained on new diverse dataset from 2000+ users from 30+ countries
-   * Trained with improved segnet from the comma-pencil community project
-   * 🥬 Dramatically improved end-to-end lateral performance 🥬
- * Toggle added to disable the use of lanelines
- * NEOS update: update packages and support for new UI
- * New offroad UI based on Qt
- * Default SSH key only used for setup
- * Kia Ceed 2019 support thanks to ZanZaD13!
- * Kia Seltos 2021 support thanks to speedking456!
- * Added support for many Volkswagen and Škoda models thanks to jyoung8607!
-
-Version 0.8.2 (2021-02-26)
-========================
- * Use model points directly in MPC (no more polyfits), making lateral planning more accurate
- * Use model heading prediction for smoother lateral control
- * Smarter actuator delay compensation
- * Improve qcamera resolution for improved video in explorer and connect
- * Adjust maximum engagement speed to better fit the model's training distribution
- * New driver monitoring model trained with 3x more diverse data
- * Improved face detection with masks
- * More predictable DM alerts when visibility is bad
- * Rewritten video streaming between openpilot processes
- * Improved longitudinal tuning on TSS2 Corolla and Rav4 thanks to briskspirit!
- * Audi A3 2015 and 2017 support thanks to keeleysam!
- * Nissan Altima 2020 support thanks to avolmensky!
- * Lexus ES Hybrid 2018 support thanks to TheInventorMan!
- * Toyota Camry Hybrid 2021 support thanks to alancyau!
-
-Version 0.8.1 (2020-12-21)
-========================
- * Original EON is deprecated, upgrade to comma two
- * Better model performance in heavy rain
- * Better lane positioning in turns
- * Fixed bug where model would cut turns on empty roads at night
- * Fixed issue where some Toyotas would not completely stop thanks to briskspirit!
- * Toyota Camry 2021 with TSS2.5 support
- * Hyundai Ioniq Electric 2020 support thanks to baldwalker!
-
-Version 0.8.0 (2020-11-30)
-========================
- * New driving model: fully 3D and improved cut-in detection
- * UI draws 2 road edges, 4 lanelines and paths in 3D
- * Major fixes to cut-in detection for openpilot longitudinal
- * Grey panda is no longer supported, upgrade to comma two or black panda
- * Lexus NX 2018 support thanks to matt12eagles!
- * Kia Niro EV 2020 support thanks to nickn17!
- * Toyota Prius 2021 support thanks to rav4kumar!
- * Improved lane positioning with uncertain lanelines, wide lanes and exits
- * Improved lateral control for Prius and Subaru
-
-Version 0.7.10 (2020-10-29)
-========================
- * Grey panda is deprecated, upgrade to comma two or black panda
- * NEOS update: update to Python 3.8.2 and lower CPU frequency
- * Improved thermals due to reduced CPU frequency
- * Update SNPE to 1.41.0
- * Reduced offroad power consumption
- * Various system stability improvements
- * Acura RDX 2020 support thanks to csouers!
-
-Version 0.7.9 (2020-10-09)
-========================
- * Improved car battery power management
- * Improved updater robustness
- * Improved realtime performance
- * Reduced UI and modeld lags
- * Increased torque on 2020 Hyundai Sonata and Palisade
-
-Version 0.7.8 (2020-08-19)
-========================
- * New driver monitoring model: improved face detection and better compatibility with sunglasses
- * Download NEOS operating system updates in the background
- * Improved updater reliability and responsiveness
- * Hyundai Kona 2020, Veloster 2019, and Genesis G70 2018 support thanks to xps-genesis!
-
-Version 0.7.7 (2020-07-20)
-========================
- * White panda is no longer supported, upgrade to comma two or black panda
- * Improved vehicle model estimation using high precision localizer
- * Improved thermal management on comma two
- * Improved autofocus for road-facing camera
- * Improved noise performance for driver-facing camera
- * Block lane change start using blindspot monitor on select Toyota, Hyundai, and Subaru
- * Fix GM ignition detection
- * Code cleanup and smaller release sizes
- * Hyundai Sonata 2020 promoted to officially supported car
- * Hyundai Ioniq Electric Limited 2019 and Ioniq SE 2020 support thanks to baldwalker!
- * Subaru Forester 2019 and Ascent 2019 support thanks to martinl!
-
-Version 0.7.6.1 (2020-06-16)
-========================
- * Hotfix: update kernel on some comma twos (orders #8570-#8680)
-
-Version 0.7.6 (2020-06-05)
-========================
- * White panda is deprecated, upgrade to comma two or black panda
- * 2017 Nissan X-Trail, 2018-19 Leaf and 2019 Rogue support thanks to avolmensky!
- * 2017 Mazda CX-5 support in dashcam mode thanks to Jafaral!
- * Huge CPU savings in modeld by using thneed!
- * Lots of code cleanup and refactors
-
-Version 0.7.5 (2020-05-13)
-========================
- * Right-Hand Drive support for both driving and driver monitoring!
- * New driving model: improved at sharp turns and lead speed estimation
- * New driver monitoring model: overall improvement on comma two
- * Driver camera preview in settings to improve mounting position
- * Added support for many Hyundai, Kia, Genesis models thanks to xx979xx!
- * Improved lateral tuning for 2020 Toyota Rav 4 (hybrid)
-
-Version 0.7.4 (2020-03-20)
-========================
- * New driving model: improved lane changes and lead car detection
- * Improved driver monitoring model: improve eye detection
- * Improved calibration stability
- * Improved lateral control on some 2019 and 2020 Toyota Prius
- * Improved lateral control on VW Golf: 20% more steering torque
- * Fixed bug where some 2017 and 2018 Toyota C-HR would use the wrong steering angle sensor
- * Support for Honda Insight thanks to theantihero!
- * Code cleanup in car abstraction layers and ui
-
-Version 0.7.3 (2020-02-21)
-========================
- * Support for 2020 Highlander thanks to che220!
- * Support for 2018 Lexus NX 300h thanks to kengggg!
- * Speed up ECU firmware query
- * Fix bug where manager would sometimes hang after shutting down the car
-
-Version 0.7.2 (2020-02-07)
-========================
- * ECU firmware version based fingerprinting for Honda & Toyota
- * New driving model: improved path prediction during turns and lane changes and better lead speed tracking
- * Improve driver monitoring under extreme lighting and add low accuracy alert
- * Support for 2019 Rav4 Hybrid thanks to illumiN8i!
- * Support for 2016, 2017 and 2020 Lexus RX thanks to illumiN8i!
- * Support for 2020 Chrysler Pacifica Hybrid thanks to adhintz!
-
-Version 0.7.1 (2020-01-20)
-========================
- * comma two support!
- * Lane Change Assist above 45 mph!
- * Replace zmq with custom messaging library, msgq!
- * Supercombo model: calibration and driving models are combined for better lead estimate
- * More robust updater thanks to jyoung8607! Requires NEOS update
- * Improve low speed ACC tuning
-
-Version 0.7 (2019-12-13)
-========================
- * Move to SCons build system!
- * Add Lane Departure Warning (LDW) for all supported vehicles!
- * NEOS update: increase wifi speed thanks to jyoung8607!
- * Adaptive driver monitoring based on scene
- * New driving model trained end-to-end: improve lane lines and lead detection
- * Smarter torque limit alerts for all cars
- * Improve GM longitudinal control: proper computations for 15Hz radar
- * Move GM port, Toyota with DSU removed, comma pedal in community features; toggle switch required
- * Remove upload over cellular toggle: only upload qlog and qcamera files if not on wifi
- * Refactor Panda code towards ISO26262 and SIL2 compliance
- * Forward stock FCW for Honda Nidec
- * Volkswagen port now standard: comma Harness intercepts stock camera
-
-Version 0.6.6 (2019-11-05)
-========================
- * Volkswagen support thanks to jyoung8607!
- * Toyota Corolla Hybrid with TSS 2.0 support thanks to u8511049!
- * Lexus ES with TSS 2.0 support thanks to energee!
- * Fix GM ignition detection and lock safety mode not required anymore
- * Log panda firmware and dongle ID thanks to martinl!
- * New driving model: improve path prediction and lead detection
- * New driver monitoring model, 4x smaller and running on DSP
- * Display an alert and don't start openpilot if panda has wrong firmware
- * Fix bug preventing EON from terminating processes after a drive
- * Remove support for Toyota giraffe without the 120Ohm resistor
-
-Version 0.6.5 (2019-10-07)
-========================
- * NEOS update: upgrade to Python3 and new installer!
- * comma Harness support!
- * New driving model: improve path prediction
- * New driver monitoring model: more accurate face and eye detection
- * Redesign offroad screen to display updates and alerts
- * Increase maximum allowed acceleration
- * Prevent car 12V battery drain by cutting off EON charge after 3 days of no drive
- * Lexus CT Hybrid support thanks to thomaspich!
- * Louder chime for critical alerts
- * Add toggle to switch to dashcam mode
- * Fix "invalid vehicle params" error on DSU-less Toyota
-
-Version 0.6.4 (2019-09-08)
-========================
- * Forward stock AEB for Honda Nidec
- * Improve lane centering on banked roads
- * Always-on forward collision warning
- * Always-on driver monitoring, except for right hand drive countries
- * Driver monitoring learns the user's normal driving position
- * Honda Fit support thanks to energee!
- * Lexus IS support
-
-Version 0.6.3 (2019-08-12)
-========================
- * Alert sounds from EON: requires NEOS update
- * Improve driver monitoring: eye tracking and improved awareness logic
- * Improve path prediction with new driving model
- * Improve lane positioning with wide lanes and exits
- * Improve lateral control on RAV4
- * Slow down for turns using model
- * Open sourced regression test to verify outputs against reference logs
- * Open sourced regression test to sanity check all car models
-
-Version 0.6.2 (2019-07-29)
-========================
- * New driving model!
- * Improve lane tracking with double lines
- * Strongly improve stationary vehicle detection
- * Strongly reduce cases of braking due to false leads
- * Better lead tracking around turns
- * Improve cut-in prediction by using neural network
- * Improve lateral control on Toyota Camry and C-HR thanks to zorrobyte!
- * Fix unintended openpilot disengagements on Jeep thanks to adhintz!
- * Fix delayed transition to offroad when car is turned off
-
-Version 0.6.1 (2019-07-21)
-========================
- * Remote SSH with comma prime and [ssh.comma.ai](https://ssh.comma.ai)
- * Panda code Misra-c2012 compliance, tested against cppcheck coverage
- * Lockout openpilot after 3 terminal alerts for driver distracted or unresponsive
- * Toyota Sienna support thanks to wocsor!
-
-Version 0.6 (2019-07-01)
-========================
- * New model, with double the pixels and ten times the temporal context!
- * Car should not take exits when in the right lane
- * openpilot uses only ~65% of the CPU (down from 75%)
- * Routes visible in connect/explorer after only 0.2% is uploaded (qlogs)
- * loggerd and sensord are open source, every line of openpilot is now open
- * Panda safety code is MISRA compliant and ships with a signed version on release2
- * New NEOS is 500MB smaller and has a reproducible usr/pipenv
- * Lexus ES Hybrid support thanks to wocsor!
- * Improve tuning for supported Toyota with TSS 2.0
- * Various other stability improvements
-
-Version 0.5.13 (2019-05-31)
-==========================
- * Reduce panda power consumption by 70%, down to 80mW, when car is off (not for GM)
- * Reduce EON power consumption by 40%, down to 1100mW, when car is off
- * Reduce CPU utilization by 20% and improve stability
- * Temporarily remove mapd functionalities to improve stability
- * Add openpilot record-only mode for unsupported cars
- * Synchronize controlsd to pandad to reduce latency
- * Remove panda support for Subaru giraffe
-
 Version 0.5.12 (2019-05-16)
 ==========================
  * Improve lateral control for the Prius and Prius Prime
@@ -733,8 +9,8 @@ Version 0.5.12 (2019-05-16)
  * Add default speed limits for Estonia thanks to martinl!
  * Subaru Crosstrek support thanks to martinl!
  * Toyota Avalon support thanks to njbrown09!
- * Toyota Rav4 with TSS 2.0 support thanks to wocsor!
- * Toyota Corolla with TSS 2.0 support thanks to wocsor!
+ * Toyota Rav4 with TSS 2.0 support thansk to wocsor!
+ * Toyota Corolla with TSS 2.0 support thansk to wocsor!
 
 Version 0.5.11 (2019-04-17)
 ========================
@@ -1015,96 +291,96 @@ Version 0.3.4 (2017-07-28)
 
 Version 0.3.3  (2017-06-28)
 ===========================
- * Improved model trained on more data
- * Alpha CR-V support thanks to energee and johnnwvs!
- * Using the opendbc project for DBC files
- * Minor performance improvements
- * UI update thanks to pjlao307
- * Power off button
- * 6% more torque on the Civic
+  * Improved model trained on more data
+  * Alpha CR-V support thanks to energee and johnnwvs!
+  * Using the opendbc project for DBC files
+  * Minor performance improvements
+  * UI update thanks to pjlao307
+  * Power off button
+  * 6% more torque on the Civic
 
 Version 0.3.2  (2017-05-22)
 ===========================
- * Minor stability bugfixes
- * Added metrics and rear view mirror disable to settings
- * Update model with more crowdsourced data
+  * Minor stability bugfixes
+  * Added metrics and rear view mirror disable to settings
+  * Update model with more crowdsourced data
 
 Version 0.3.1  (2017-05-17)
 ===========================
- * visiond stability bugfix
- * Add logging for angle and flashing
+  * visiond stability bugfix
+  * Add logging for angle and flashing
 
 Version 0.3.0  (2017-05-12)
 ===========================
- * Add CarParams struct to improve the abstraction layer
- * Refactor visiond IPC to support multiple clients
- * Add raw GPS and beginning support for navigation
- * Improve model in visiond using crowdsourced data
- * Add improved system logging to diagnose instability
- * Rewrite baseui in React Native
- * Moved calibration to the cloud
+  * Add CarParams struct to improve the abstraction layer
+  * Refactor visiond IPC to support multiple clients
+  * Add raw GPS and beginning support for navigation
+  * Improve model in visiond using crowdsourced data
+  * Add improved system logging to diagnose instability
+  * Rewrite baseui in React Native
+  * Moved calibration to the cloud
 
 Version 0.2.9  (2017-03-01)
 ===========================
- * Retain compatibility with NEOS v1
+  * Retain compatibility with NEOS v1
 
 Version 0.2.8  (2017-02-27)
 ===========================
- * Fix bug where frames were being dropped in minute 71
+  * Fix bug where frames were being dropped in minute 71
 
 Version 0.2.7  (2017-02-08)
 ===========================
- * Better performance and pictures at night
- * Fix ptr alignment issue in pandad
- * Fix brake error light, fix crash if too cold
+  * Better performance and pictures at night
+  * Fix ptr alignment issue in boardd
+  * Fix brake error light, fix crash if too cold
 
 Version 0.2.6  (2017-01-31)
 ===========================
- * Fix bug in visiond model execution
+  * Fix bug in visiond model execution
 
 Version 0.2.5  (2017-01-30)
 ===========================
- * Fix race condition in manager
+  * Fix race condition in manager
 
 Version 0.2.4  (2017-01-27)
 ===========================
- * OnePlus 3T support
- * Enable installation as NEOS app
- * Various minor bugfixes
+  * OnePlus 3T support
+  * Enable installation as NEOS app
+  * Various minor bugfixes
 
 Version 0.2.3  (2017-01-11)
 ===========================
- * Reduce space usage by 80%
- * Add better logging
- * Add Travis CI
+  * Reduce space usage by 80%
+  * Add better logging
+  * Add Travis CI
 
 Version 0.2.2  (2017-01-10)
 ===========================
- * Board triggers started signal on CAN messages
- * Improved autoexposure
- * Handle out of space, improve upload status
+  * Board triggers started signal on CAN messages
+  * Improved autoexposure
+  * Handle out of space, improve upload status
 
 Version 0.2.1  (2016-12-14)
 ===========================
- * Performance improvements, removal of more numpy
- * Fix pandad process priority
- * Make counter timer reset on use of steering wheel
+  * Performance improvements, removal of more numpy
+  * Fix boardd process priority
+  * Make counter timer reset on use of steering wheel
 
 Version 0.2  (2016-12-12)
 =========================
- * Car/Radar abstraction layers have shipped, see cereal/car.capnp
- * controlsd has been refactored
- * Shipped plant model and testing maneuvers
- * visiond exits more gracefully now
- * Hardware encoder in visiond should always init
- * ui now turns off the screen after 30 seconds
- * Switch to openpilot release branch for future releases
- * Added preliminary Docker container to run tests on PC
+  * Car/Radar abstraction layers have shipped, see cereal/car.capnp
+  * controlsd has been refactored
+  * Shipped plant model and testing maneuvers
+  * visiond exits more gracefully now
+  * Hardware encoder in visiond should always init
+  * ui now turns off the screen after 30 seconds
+  * Switch to openpilot release branch for future releases
+  * Added preliminary Docker container to run tests on PC
 
 Version 0.1  (2016-11-29)
 =========================
- * Initial release of openpilot
- * Adaptive cruise control is working
- * Lane keep assist is working
- * Support for Acura ILX 2016 with AcuraWatch Plus
- * Support for Honda Civic 2016 Touring Edition
+  * Initial release of openpilot
+  * Adaptive cruise control is working
+  * Lane keep assist is working
+  * Support for Acura ILX 2016 with AcuraWatch Plus
+  * Support for Honda Civic 2016 Touring Edition

SAFETY.md

@@ -0,0 +1,151 @@
+openpilot Safety
+======
+
+openpilot is an Adaptive Cruise Control (ACC) and Lane Keeping Assist (LKA) system. 
+Like other ACC and LKA systems, openpilot requires the driver to be alert and to 
+pay attention at all times. We repeat, **driver alertness is necessary, but not 
+sufficient, for openpilot to be used safely**.
+
+In order to enforce driver alertness, openpilot includes a driver monitoring feature
+that alerts the driver when distracted.
+
+However, even with an attentive driver, we must make further efforts for the system to be
+safe. We have designed openpilot with two other safety considerations.
+
+1. The driver must always be capable to immediately retake manual control of the vehicle, 
+   by stepping on either pedal or by pressing the cancel button.
+2. The vehicle must not alter its trajectory too quickly for the driver to safely
+   react. This means that while the system is engaged, the actuators are constrained
+   to operate within reasonable limits.
+
+Following are details of the car specific safety implementations:
+
+Honda/Acura
+------
+
+  - While the system is engaged, gas, brake and steer commands are subject to the same limits used by
+    the stock system.
+
+  - Without an interceptor, the gas is controlled by the Powertrain Control Module (PCM). 
+    The PCM limits acceleration to what is reasonable for a cruise control system.  With an
+    interceptor, the gas is clipped to 60%.
+
+  - The brake is controlled by the 0x1FA CAN message. This message allows full
+    braking, although the panda firmware and openpilot clip it to 1/4th of the max.
+    This is approximately 0.3g of braking.
+
+  - Steering is controlled by the 0xE4 CAN message. The Electronic Power Steering (EPS) 
+    controller in the car limits the torque to a very small amount, so regardless of the 
+    message, the controller cannot jerk the wheel.
+
+  - Brake and gas pedal pressed signals are contained in the 0x17C CAN message. A rising edge of
+    either signals triggers a disengagement, which is enforced by the panda firmware and by openpilot. The
+    white led on the panda signifies if the panda is allowing control messages.
+
+  - Honda CAN uses both a counter and a checksum to ensure integrity and prevent
+    replay of the same message.
+
+Toyota/Lexus
+------
+
+  - While the system is engaged, gas, brake and steer commands are subject to the same limits used by
+    the stock system.
+
+  - With the stock Driving Support Unit (DSU) connected (or in DSU-less models like Camry and C-HR),
+    the acceleration is controlled by the stock system and is subject to the stock adaptive cruise
+    control limits. Without the stock DSU connected, the acceleration command is controlled by the
+    0x343 CAN message and its value is limited between .3g of deceleration and .15g of acceleration
+    by the panda firmware and by openpilot. The acceleration command is ignored by the Engine Control
+    Module (ECM) while the cruise control system is disengaged.
+
+  - Steering torque is controlled through the 0x2E4 CAN message and it's limited by the panda firmware and by
+    openpilot to a value between -1500 and 1500. In addition, the vehicle EPS unit will not respond to
+    commands outside these limits.  A steering torque rate limit is enforced by the panda firmware and by
+    openpilot, so that the commanded steering torque must rise from 0 to max value no faster than
+    1.5s. Commanded steering torque is limited by the panda firmware and by openpilot to be no more than 350
+    units above the actual EPS generated motor torque to ensure limited differences between
+    commanded and actual torques.
+
+  - Brake and gas pedal pressed signals are contained in the 0x224 and 0x1D2 CAN messages,
+    respectively. A rising edge of either signals triggers a disengagement, which is enforced by the
+    panda firmware and by openpilot. Additionally, the cruise control system disengages on the rising edge of
+    the brake pedal pressed signal.
+
+  - The cruise control system state is contained in the 0x1D2 message. No control messages are
+    allowed if the cruise control system is not active. This is enforced by openpilot and the
+    panda firmware. The white led on the panda signifies if the panda is allowing control messages.
+
+GM/Chevrolet
+------
+
+  - While the system is engaged, gas, brake and steer commands are subject to the same limits used by
+    the stock system.
+
+  - The gas and regen are controlled by the 0x2CB message and it's limited by the panda firmware and by
+    openpilot to a value between 1404 and 3072. the minimum value correspond to a mild decel due to regen,
+    while 3072 correspond to approximately 0.18g of acceleration from stop.
+
+  - The friction brakes are controlled by the 0x315 message and its value is limited by the panda firmware
+    and openpilot to 350. This is approximately 0.3g of braking.
+
+  - Steering torque is controlled through the 0x180 CAN message and it's limited by the panda firmware and by
+    openpilot to a value between -300 and 300. In addition, the vehicle EPS unit will fault for
+    commands outside these limits.  A steering torque rate limit is enforced by the panda firmware and by
+    openpilot, so that the commanded steering torque must rise from 0 to max value no faster than
+    0.75s. Commanded steering torque is gradually limited by the panda firmware and by openpilot if the driver's
+    torque exceeds 12 units in the opposite dicrection to ensure limited applied torque against the
+    driver's will.
+
+  - Brake pedal and gas pedal potentiometer signals are contained in the 0xF1 and 0x1A1 CAN messages,
+    respectively. A rising edge of either signals triggers a disengagement, which is enforced by the
+    panda firmware and by openpilot. Additionally, the cruise control system disengages on the rising edge of
+    the brake pedal pressed signal. The regen paddle pressed signal is in the 0xBD message. When the
+    regen paddle is pressed, a disengagement is enforced by both the firmware and by openpilot.
+
+  - GM CAN uses both a counter and a checksum to ensure integrity and prevent
+    replay of the same message.
+
+Hyundai/Kia (Lateral only)
+------
+
+  - While the system is engaged, steer commands are subject to the same limits used by
+    the stock system.
+
+  - Steering torque is controlled through the 0x340 CAN message and it's limited by the panda firmware and by
+    openpilot to a value between -255 and 255. In addition, the vehicle EPS unit will fault for
+    commands outside the values of -409 and 409. A steering torque rate limit is enforced by the panda firmware and by
+    openpilot, so that the commanded steering torque must rise from 0 to max value no faster than
+    0.85s. Commanded steering torque is gradually limited by the panda firmware and by openpilot if the driver's
+    torque exceeds 50 units in the opposite dicrection to ensure limited applied torque against the
+    driver's will.
+
+Chrysler/Jeep/Fiat (Lateral only)
+------
+
+  - While the system is engaged, steer commands are subject to the same limits used by
+    the stock system.
+
+  - Steering torque is controlled through the 0x292 CAN message and it's limited by the panda firmware and by
+    openpilot to a value between -261 and 261. In addition, the vehicle EPS unit will fault for
+    commands outside these limits. A steering torque rate limit is enforced by the panda firmware and by
+    openpilot, so that the commanded steering torque must rise from 0 to max value no faster than
+    0.87s. Commanded steering torque is limited by the panda firmware and by openpilot to be no more than 80
+    units above the actual EPS generated motor torque to ensure limited differences between
+    commanded and actual torques.
+
+Subaru (Lateral only)
+------
+
+  - While the system is engaged, steer commands are subject to the same limits used by
+    the stock system.
+
+  - Steering torque is controlled through the 0x122 CAN message and it's limited by the panda firmware and by
+    openpilot to a value between -255 and 255. In addition, the vehicle EPS unit will fault for
+    commands outside the values of -2047 and 2047. A steering torque rate limit is enforced by the panda firmware and by
+    openpilot, so that the commanded steering torque must rise from 0 to max value no faster than
+    0.41s. Commanded steering torque is gradually limited by the panda firmware and by openpilot if the driver's
+    torque exceeds 60 units in the opposite dicrection to ensure limited applied torque against the
+    driver's will.
+
+**Extra note**: comma.ai strongly discourages the use of openpilot forks with safety code either missing or
+  not fully meeting the above requirements.

SConstruct

@@ -1,238 +0,0 @@
-import os
-import subprocess
-import sys
-import sysconfig
-import platform
-import shlex
-import importlib
-import numpy as np
-
-import SCons.Errors
-
-SCons.Warnings.warningAsException(True)
-
-Decider('MD5-timestamp')
-
-SetOption('num_jobs', max(1, int(os.cpu_count()/2)))
-
-AddOption('--asan', action='store_true', help='turn on ASAN')
-AddOption('--ubsan', action='store_true', help='turn on UBSan')
-AddOption('--mutation', action='store_true', help='generate mutation-ready code')
-AddOption('--ccflags', action='store', type='string', default='', help='pass arbitrary flags over the command line')
-AddOption('--verbose', action='store_true', default=False, help='show full build commands')
-AddOption('--minimal',
-          action='store_false',
-          dest='extras',
-          default=os.path.exists(File('#.gitattributes').abspath), # minimal by default on release branch (where there's no LFS)
-          help='the minimum build to run openpilot. no tests, tools, etc.')
-
-# Detect platform
-arch = subprocess.check_output(["uname", "-m"], encoding='utf8').rstrip()
-if platform.system() == "Darwin":
-  arch = "Darwin"
-elif arch == "aarch64" and os.path.isfile('/TICI'):
-  arch = "larch64"
-assert arch in [
-  "larch64",  # linux tici arm64
-  "aarch64",  # linux pc arm64
-  "x86_64",   # linux pc x64
-  "Darwin",   # macOS arm64 (x86 not supported)
-]
-
-pkg_names = ['bzip2', 'capnproto', 'eigen', 'ffmpeg', 'libjpeg', 'libyuv', 'ncurses', 'zeromq', 'zstd']
-pkgs = [importlib.import_module(name) for name in pkg_names]
-py_include = importlib.import_module('python3_dev').INCLUDE_DIR
-
-env = Environment(
-  ENV={
-    "PATH": os.environ['PATH'],
-    "PYTHONPATH": Dir("#").abspath + ':' + Dir(f"#third_party/acados").abspath,
-    "ACADOS_SOURCE_DIR": Dir("#third_party/acados").abspath,
-    "ACADOS_PYTHON_INTERFACE_PATH": Dir("#third_party/acados/acados_template").abspath,
-    "TERA_PATH": Dir("#").abspath + f"/third_party/acados/{arch}/t_renderer"
-  },
-  CCFLAGS=[
-    "-g",
-    "-fPIC",
-    "-O2",
-    "-Wunused",
-    "-Werror",
-    "-Wshadow" if arch in ("Darwin", "larch64") else "-Wshadow=local",
-    "-Wno-unknown-warning-option",
-    "-Wno-inconsistent-missing-override",
-    "-Wno-c99-designator",
-    "-Wno-reorder-init-list",
-    "-Wno-vla-cxx-extension",
-  ],
-  CFLAGS=["-std=gnu11"],
-  CXXFLAGS=["-std=c++1z"],
-  CPPPATH=[
-    "#",
-    "#msgq",
-    "#third_party",
-    "#third_party/json11",
-    "#third_party/linux/include",
-    "#third_party/acados/include",
-    "#third_party/acados/include/blasfeo/include",
-    "#third_party/acados/include/hpipm/include",
-    "#third_party/catch2/include",
-    [x.INCLUDE_DIR for x in pkgs],
-  ],
-  LIBPATH=[
-    "#common",
-    "#msgq_repo",
-    "#third_party",
-    "#selfdrive/pandad_tici" if "TICI_DOS" in os.environ else "#selfdrive/pandad",
-    "#rednose/helpers",
-    f"#third_party/acados/{arch}/lib",
-    [x.LIB_DIR for x in pkgs],
-  ],
-  RPATH=[],
-  CYTHONCFILESUFFIX=".cpp",
-  COMPILATIONDB_USE_ABSPATH=True,
-  REDNOSE_ROOT="#",
-  tools=["default", "cython", "compilation_db", "rednose_filter"],
-  toolpath=["#site_scons/site_tools", "#rednose_repo/site_scons/site_tools"],
-)
-
-# Arch-specific flags and paths
-if arch == "larch64":
-  env["CC"] = "clang"
-  env["CXX"] = "clang++"
-  env.Append(LIBPATH=[
-    "/usr/local/lib",
-    "/system/vendor/lib64",
-    "/usr/lib/aarch64-linux-gnu",
-  ])
-  arch_flags = ["-D__TICI__", "-mcpu=cortex-a57"]
-  env.Append(CCFLAGS=arch_flags)
-  env.Append(CXXFLAGS=arch_flags)
-elif arch == "Darwin":
-  env.Append(LIBPATH=[
-    "/System/Library/Frameworks/OpenGL.framework/Libraries",
-  ])
-  env.Append(CCFLAGS=["-DGL_SILENCE_DEPRECATION"])
-  env.Append(CXXFLAGS=["-DGL_SILENCE_DEPRECATION"])
-else:
-  env.Append(LIBPATH=[
-    "/usr/lib",
-    "/usr/local/lib",
-  ])
-
-# Sanitizers and extra CCFLAGS from CLI
-if GetOption('asan'):
-  env.Append(CCFLAGS=["-fsanitize=address", "-fno-omit-frame-pointer"])
-  env.Append(LINKFLAGS=["-fsanitize=address"])
-elif GetOption('ubsan'):
-  env.Append(CCFLAGS=["-fsanitize=undefined"])
-  env.Append(LINKFLAGS=["-fsanitize=undefined"])
-
-_extra_cc = shlex.split(GetOption('ccflags') or '')
-if _extra_cc:
-  env.Append(CCFLAGS=_extra_cc)
-
-# no --as-needed on mac linker
-if arch != "Darwin":
-  env.Append(LINKFLAGS=["-Wl,--as-needed", "-Wl,--no-undefined"])
-
-# Shorter build output: show brief descriptions instead of full commands.
-# Full command lines are still printed on failure by scons.
-if not GetOption('verbose'):
-  for action, short in (
-    ("CC",     "CC"),
-    ("CXX",    "CXX"),
-    ("LINK",   "LINK"),
-    ("SHCC",   "CC"),
-    ("SHCXX",  "CXX"),
-    ("SHLINK", "LINK"),
-    ("AR",     "AR"),
-    ("RANLIB", "RANLIB"),
-    ("AS",     "AS"),
-  ):
-    env[f"{action}COMSTR"] = f"  [{short}] $TARGET"
-
-# progress output
-node_interval = 5
-node_count = 0
-def progress_function(node):
-  global node_count
-  node_count += node_interval
-  sys.stderr.write("progress: %d\n" % node_count)
-if os.environ.get('SCONS_PROGRESS'):
-  Progress(progress_function, interval=node_interval)
-
-# ********** Cython build environment **********
-envCython = env.Clone()
-envCython["CPPPATH"] += [py_include, np.get_include()]
-envCython["CCFLAGS"] += ["-Wno-#warnings", "-Wno-cpp", "-Wno-shadow", "-Wno-deprecated-declarations"]
-envCython["CCFLAGS"].remove("-Werror")
-
-envCython["LIBS"] = []
-if arch == "Darwin":
-  envCython["LINKFLAGS"] = env["LINKFLAGS"] + ["-bundle", "-undefined", "dynamic_lookup"]
-else:
-  envCython["LINKFLAGS"] = ["-pthread", "-shared"]
-
-np_version = SCons.Script.Value(np.__version__)
-Export('envCython', 'np_version')
-
-Export('env', 'arch')
-
-# Setup cache dir
-cache_dir = '/data/scons_cache' if arch == "larch64" else '/tmp/scons_cache'
-CacheDir(cache_dir)
-Clean(["."], cache_dir)
-
-# dragonpilot settings generation — runs every scons invocation, idempotent.
-# Writes common/params_keys.h in place; we don't declare a target so scons
-# treats it purely as a pre-build side effect.
-if env.Execute('./generate_settings.py') != 0:
-  Exit('generate_settings.py failed')
-
-# ********** start building stuff **********
-
-# Build common module
-SConscript(['common/SConscript'])
-Import('_common')
-common = [_common, 'json11', 'zmq']
-Export('common')
-
-# Build messaging (cereal + msgq + socketmaster + their dependencies)
-# Enable swaglog include in submodules
-env_swaglog = env.Clone()
-env_swaglog['CXXFLAGS'].append('-DSWAGLOG="\\"common/swaglog.h\\""')
-SConscript(['msgq_repo/SConscript'], exports={'env': env_swaglog})
-SConscript(['opendbc_repo/SConscript'], exports={'env': env_swaglog})
-
-SConscript(['cereal/SConscript'])
-
-Import('socketmaster', 'msgq')
-messaging = [socketmaster, msgq, 'capnp', 'kj',]
-Export('messaging')
-
-
-# Build other submodules
-SConscript(['panda/SConscript'])
-SConscript(['panda_tici/SConscript'])
-
-# Build rednose library
-SConscript(['rednose/SConscript'])
-
-# Build system services
-SConscript([
-  'system/loggerd/SConscript',
-])
-
-if arch == "larch64":
-  SConscript(['system/camerad/SConscript'])
-
-# Build openpilot
-SConscript(['third_party/SConscript'])
-
-SConscript(['selfdrive/SConscript'])
-
-if Dir('#tools/cabana/').exists() and arch != "larch64":
-  SConscript(['tools/cabana/SConscript'])
-
-
-env.CompilationDatabase('compile_commands.json')

SECURITY.md

@@ -1,5 +0,0 @@
-# Security Policy
-
-## Reporting a Vulnerability
-
-Suspected vulnerabilities can be reported to both `adeeb@comma.ai` and `security@comma.ai`.

SPONSORS.md

@@ -1,26 +0,0 @@
-# Sponsors 贊助者
-
-我們誠摯感謝以下贊助者提供的硬體資源，讓專案能夠在多種平台上進行測試與驗證。
-
-We sincerely thank the following sponsors for providing hardware resources, which enable the project to be tested and validated across multiple platforms.
-
----
-
-## 贊助者列表 Sponsors
-
-| 贊助者 Sponsor | 設備 Deices | 備註 Notes |
-| -------------- | ----------- | ---------- |
-| BlueGood | <ul><li>Radar Filter x 2</li><li>sDSU x1</li></ul> | - |
-| Chia Chun Lee | <ul><li>C3 Quick Mount x1</li></ul> | - |
-| CloudJ | <ul><li>C3X x1</li></ul> | - |
-| FareWay | <ul><li>EON Quick Mount x1</li><li>C2/C3 Quick Mount x1</li></ul> | Special thanks for fixing my good old EON |
-| Fred Wang | <ul><li>Oneplus 3t x1</li></ul> | - |
-| Saber Huang | <ul><li>O3L x1</li></ul> | - |
-| [馬威 Mr. One](https://shop61532546.taobao.com/) | <ul><li>O3 x 1</li><li>O3 (Dev) x1</li><li>O3XL x1</li><li>Red Panda x1</li><li>Panda Jungle v1 x1</li></ul> | - |
-| 門文梁 | <ul><li>C1.5 x1</li></ul> | - |
-
----
-
-🙏 沒有你們的支持，我們無法讓專案在這麼多硬體平台上持續成長與驗證。
-
-Without your support, this project could not continue to grow and be validated across so many hardware platforms.

cereal/.gitignore

@@ -0,0 +1,3 @@
+gen
+node_modules
+package-lock.json

cereal/Makefile

@@ -0,0 +1,62 @@
+PWD := $(shell pwd)
+
+SRCS := log.capnp car.capnp
+
+GENS := gen/cpp/car.capnp.c++ gen/cpp/log.capnp.c++
+JS := gen/js/car.capnp.js gen/js/log.capnp.js
+
+UNAME_M ?= $(shell uname -m)
+
+GENS += gen/c/car.capnp.c gen/c/log.capnp.c gen/c/include/c++.capnp.h gen/c/include/java.capnp.h
+
+ifeq ($(UNAME_M),x86_64)
+
+ifneq (, $(shell which capnpc-java))
+GENS += gen/java/Car.java gen/java/Log.java
+else
+$(warning capnpc-java not found, skipping java build)
+endif
+
+endif
+
+
+ifeq ($(UNAME_M),aarch64)
+CAPNPC=PATH=$(PWD)/../phonelibs/capnp-cpp/aarch64/bin/:$$PATH capnpc
+else
+CAPNPC=capnpc
+endif
+
+.PHONY: all
+all: $(GENS)
+js: $(JS)
+
+.PHONY: clean
+clean:
+	rm -rf gen
+	rm -rf node_modules
+	rm -rf package-lock.json
+
+gen/c/%.capnp.c: %.capnp
+	@echo "[ CAPNPC C ] $@"
+	mkdir -p gen/c/
+	$(CAPNPC) '$<' -o c:gen/c/
+
+gen/js/%.capnp.js: %.capnp
+	@echo "[ CAPNPC JavaScript ] $@"
+	mkdir -p gen/js/
+	sh ./generate_javascript.sh
+
+gen/cpp/%.capnp.c++: %.capnp
+	@echo "[ CAPNPC C++ ] $@"
+	mkdir -p gen/cpp/
+	$(CAPNPC) '$<' -o c++:gen/cpp/
+
+gen/java/Car.java gen/java/Log.java: $(SRCS)
+	@echo "[ CAPNPC java ] $@"
+	mkdir -p gen/java/
+	$(CAPNPC) $^ -o java:gen/java
+
+# c-capnproto needs some empty headers
+gen/c/include/c++.capnp.h gen/c/include/java.capnp.h:
+	mkdir -p gen/c/include
+	touch '$@'

cereal/README.md

@@ -1,95 +0,0 @@
-# What is cereal?
-
-cereal is the messaging system for openpilot. It uses [msgq](https://github.com/commaai/msgq) as a pub/sub backend, and [Cap'n proto](https://capnproto.org/capnp-tool.html) for serialization of the structs.
-
-
-## Messaging Spec
-
-You'll find the message types in [log.capnp](log.capnp). It uses [Cap'n proto](https://capnproto.org/capnp-tool.html) and defines one struct called `Event`.
-
-All `Events` have a `logMonoTime` and a `valid`. Then a big union defines the packet type.
-
-### Best Practices
-
-- **All fields must describe quantities in SI units**, unless otherwise specified in the field name.
-- In the context of the message they are in, field names should be completely unambiguous.
-- All values should be easy to plot and be human-readable with minimal parsing.
-
-### Maintaining backwards-compatibility
-
-When making changes to the messaging spec you want to maintain backwards-compatibility, such that old logs can
-be parsed with a new version of cereal. Adding structs and adding members to structs is generally safe, most other
-things are not. Read more details [here](https://capnproto.org/language.html).
-
-### Custom forks
-
-Forks of [openpilot](https://github.com/commaai/openpilot) might want to add things to the messaging
-spec, however this could conflict with future changes made in mainline cereal/openpilot. Rebasing against mainline openpilot
-then means breaking backwards-compatibility with all old logs of your fork. So we added reserved events in
-[custom.capnp](custom.capnp) that we will leave empty in mainline cereal/openpilot. **If you only modify those, you can ensure your
-fork will remain backwards-compatible with all versions of mainline openpilot and your fork.**
-
-An example of compatible changes:
-```diff
-diff --git a/cereal/custom.capnp b/cereal/custom.capnp
-index 3348e859e..3365c7b98 100644
---- a/cereal/custom.capnp
-+++ b/cereal/custom.capnp
-@@ -10,7 +10,11 @@ $Cxx.namespace("cereal");
- # DO rename the structs
- # DON'T change the identifier (e.g. @0x81c2f05a394cf4af)
-
--struct CustomReserved0 @0x81c2f05a394cf4af {
-+struct SteeringInfo @0x81c2f05a394cf4af {
-+  active @0 :Bool;
-+  steeringAngleDeg @1 :Float32;
-+  steeringRateDeg @2 :Float32;
-+  steeringAccelDeg @3 :Float32;
- }
-
- struct CustomReserved1 @0xaedffd8f31e7b55d {
-diff --git a/cereal/log.capnp b/cereal/log.capnp
-index 1209f3fd9..b189f58b6 100644
---- a/cereal/log.capnp
-+++ b/cereal/log.capnp
-@@ -2558,14 +2558,14 @@ struct Event {
-
-     # DO change the name of the field
-     # DON'T change anything after the "@"
--    customReservedRawData0 @124 :Data;
-+    rawCanData @124 :Data;
-     customReservedRawData1 @125 :Data;
-     customReservedRawData2 @126 :Data;
-
-     # DO change the name of the field and struct
-     # DON'T change the ID (e.g. @107)
-     # DON'T change which struct it points to
--    customReserved0 @107 :Custom.CustomReserved0;
-+    steeringInfo @107 :Custom.SteeringInfo;
-     customReserved1 @108 :Custom.CustomReserved1;
-     customReserved2 @109 :Custom.CustomReserved2;
-     customReserved3 @110 :Custom.CustomReserved3;
-```
-
----
-
-Example
----
-```python
-import cereal.messaging as messaging
-
-# in subscriber
-sm = messaging.SubMaster(['sensorEvents'])
-while 1:
-  sm.update()
-  print(sm['sensorEvents'])
-
-```
-
-```python
-# in publisher
-pm = messaging.PubMaster(['sensorEvents'])
-dat = messaging.new_message('sensorEvents', size=1)
-dat.sensorEvents[0] = {"gyro": {"v": [0.1, -0.1, 0.1]}}
-pm.send('sensorEvents', dat)
-```

cereal/SConscript

@@ -1,20 +0,0 @@
-Import('env', 'common', 'msgq')
-
-cereal_dir = Dir('.')
-gen_dir = Dir('gen')
-
-# Build cereal
-schema_files = ['log.capnp', 'car.capnp', 'legacy.capnp', 'custom.capnp']
-env.Command([f'gen/cpp/{s}.c++' for s in schema_files] + [f'gen/cpp/{s}.h' for s in schema_files],
-            schema_files,
-            f"capnpc --src-prefix={cereal_dir.path} $SOURCES -o c++:{gen_dir.path}/cpp/")
-
-cereal = env.Library('cereal', [f'gen/cpp/{s}.c++' for s in schema_files])
-
-# Build messaging
-services_h = env.Command(['services.h'], ['services.py'], 'python3 ' + cereal_dir.path + '/services.py > $TARGET')
-env.Program('messaging/bridge', ['messaging/bridge.cc', 'messaging/msgq_to_zmq.cc', 'messaging/bridge_zmq.cc'], LIBS=[msgq, common, 'pthread'])
-
-socketmaster = env.Library('socketmaster', ['messaging/socketmaster.cc'])
-
-Export('cereal', 'socketmaster')

cereal/__init__.py

@@ -1,11 +1,8 @@
 import os
 import capnp
-from importlib.resources import as_file, files
 
+CEREAL_PATH = os.path.dirname(os.path.abspath(__file__))
 capnp.remove_import_hook()
 
-with as_file(files("cereal")) as fspath:
-  CEREAL_PATH = fspath.as_posix()
-  log = capnp.load(os.path.join(CEREAL_PATH, "log.capnp"))
-  car = capnp.load(os.path.join(CEREAL_PATH, "car.capnp"))
-  custom = capnp.load(os.path.join(CEREAL_PATH, "custom.capnp"))
+log = capnp.load(os.path.join(CEREAL_PATH, "log.capnp"))
+car = capnp.load(os.path.join(CEREAL_PATH, "car.capnp"))

cereal/car.capnp

@@ -1 +0,0 @@
-../opendbc_repo/opendbc/car/car.capnp

cereal/car.capnp

@@ -0,0 +1,383 @@
+using Cxx = import "./include/c++.capnp";
+$Cxx.namespace("cereal");
+
+using Java = import "./include/java.capnp";
+$Java.package("ai.comma.openpilot.cereal");
+$Java.outerClassname("Car");
+
+@0x8e2af1e708af8b8d;
+
+# ******* events causing controls state machine transition *******
+
+struct CarEvent @0x9b1657f34caf3ad3 {
+  name @0 :EventName;
+  enable @1 :Bool;
+  noEntry @2 :Bool;
+  warning @3 :Bool;
+  userDisable @4 :Bool;
+  softDisable @5 :Bool;
+  immediateDisable @6 :Bool;
+  preEnable @7 :Bool;
+  permanent @8 :Bool;
+
+  enum EventName @0xbaa8c5d505f727de {
+    # TODO: copy from error list
+    commIssue @0;
+    steerUnavailable @1;
+    brakeUnavailable @2;
+    gasUnavailable @3;
+    wrongGear @4;
+    doorOpen @5;
+    seatbeltNotLatched @6;
+    espDisabled @7;
+    wrongCarMode @8;
+    steerTempUnavailable @9;
+    reverseGear @10;
+    buttonCancel @11;
+    buttonEnable @12;
+    pedalPressed @13;
+    cruiseDisabled @14;
+    radarCommIssue @15;
+    dataNeeded @16;
+    speedTooLow @17;
+    outOfSpace @18;
+    overheat @19;
+    calibrationIncomplete @20;
+    calibrationInvalid @21;
+    controlsMismatch @22;
+    pcmEnable @23;
+    pcmDisable @24;
+    noTarget @25;
+    radarFault @26;
+    modelCommIssue @27;
+    brakeHold @28;
+    parkBrake @29;
+    manualRestart @30;
+    lowSpeedLockout @31;
+    plannerError @32;
+    ipasOverride @33;
+    debugAlert @34;
+    steerTempUnavailableMute @35;
+    resumeRequired @36;
+    preDriverDistracted @37;
+    promptDriverDistracted @38;
+    driverDistracted @39;
+    geofence @40;
+    driverMonitorOn @41;
+    driverMonitorOff @42;
+    preDriverUnresponsive @43;
+    promptDriverUnresponsive @44;
+    driverUnresponsive @45;
+    belowSteerSpeed @46;
+    calibrationProgress @47;
+    lowBattery @48;
+    invalidGiraffeHonda @49;
+    vehicleModelInvalid @50;
+    controlsFailed @51;
+  }
+}
+
+# ******* main car state @ 100hz *******
+# all speeds in m/s
+
+struct CarState {
+  errorsDEPRECATED @0 :List(CarEvent.EventName);
+  events @13 :List(CarEvent);
+
+  # car speed
+  vEgo @1 :Float32;         # best estimate of speed
+  aEgo @16 :Float32;        # best estimate of acceleration
+  vEgoRaw @17 :Float32;     # unfiltered speed from CAN sensors
+  yawRate @22 :Float32;     # best estimate of yaw rate
+  standstill @18 :Bool;
+  wheelSpeeds @2 :WheelSpeeds;
+
+  # gas pedal, 0.0-1.0
+  gas @3 :Float32;        # this is user + computer
+  gasPressed @4 :Bool;    # this is user pedal only
+
+  # brake pedal, 0.0-1.0
+  brake @5 :Float32;      # this is user pedal only
+  brakePressed @6 :Bool;  # this is user pedal only
+  brakeLights @19 :Bool;
+
+  # steering wheel
+  steeringAngle @7 :Float32;   # deg
+  steeringRate @15 :Float32;   # deg/s
+  steeringTorque @8 :Float32;  # TODO: standardize units
+  steeringPressed @9 :Bool;    # if the user is using the steering wheel
+
+  # cruise state
+  cruiseState @10 :CruiseState;
+
+  # gear
+  gearShifter @14 :GearShifter;
+
+  # button presses
+  buttonEvents @11 :List(ButtonEvent);
+  leftBlinker @20 :Bool;
+  rightBlinker @21 :Bool;
+  genericToggle @23 :Bool;
+
+  # lock info
+  doorOpen @24 :Bool;
+  seatbeltUnlatched @25 :Bool;
+
+  # which packets this state came from
+  canMonoTimes @12: List(UInt64);
+
+  struct WheelSpeeds {
+    # optional wheel speeds
+    fl @0 :Float32;
+    fr @1 :Float32;
+    rl @2 :Float32;
+    rr @3 :Float32;
+  }
+
+  struct CruiseState {
+    enabled @0 :Bool;
+    speed @1 :Float32;
+    available @2 :Bool;
+    speedOffset @3 :Float32;
+    standstill @4 :Bool;
+  }
+
+  enum GearShifter {
+    unknown @0;
+    park @1;
+    drive @2;
+    neutral @3;
+    reverse @4;
+    sport @5;
+    low @6;
+    brake @7;
+  }
+
+
+  # send on change
+  struct ButtonEvent {
+    pressed @0 :Bool;
+    type @1 :Type;
+
+    enum Type {
+      unknown @0;
+      leftBlinker @1;
+      rightBlinker @2;
+      accelCruise @3;
+      decelCruise @4;
+      cancel @5;
+      altButton1 @6;
+      altButton2 @7;
+      altButton3 @8;
+    }
+  }
+}
+
+# ******* radar state @ 20hz *******
+
+struct RadarState {
+  errors @0 :List(Error);
+  points @1 :List(RadarPoint);
+
+  # which packets this state came from
+  canMonoTimes @2 :List(UInt64);
+
+  enum Error {
+    commIssue @0;
+    fault @1;
+    wrongConfig @2;
+  }
+
+  # similar to LiveTracks
+  # is one timestamp valid for all? I think so
+  struct RadarPoint {
+    trackId @0 :UInt64;  # no trackId reuse
+
+    # these 3 are the minimum required
+    dRel @1 :Float32; # m from the front bumper of the car
+    yRel @2 :Float32; # m
+    vRel @3 :Float32; # m/s
+
+    # these are optional and valid if they are not NaN
+    aRel @4 :Float32; # m/s^2
+    yvRel @5 :Float32; # m/s
+
+    # some radars flag measurements VS estimates
+    measured @6 :Bool;
+  }
+}
+
+# ******* car controls @ 100hz *******
+
+struct CarControl {
+  # must be true for any actuator commands to work
+  enabled @0 :Bool;
+  active @7 :Bool;
+
+  gasDEPRECATED @1 :Float32;
+  brakeDEPRECATED @2 :Float32;
+  steeringTorqueDEPRECATED @3 :Float32;
+
+  actuators @6 :Actuators;
+
+  cruiseControl @4 :CruiseControl;
+  hudControl @5 :HUDControl;
+
+  struct Actuators {
+    # range from 0.0 - 1.0
+    gas @0: Float32;
+    brake @1: Float32;
+    # range from -1.0 - 1.0
+    steer @2: Float32;
+    steerAngle @3: Float32;
+  }
+
+  struct CruiseControl {
+    cancel @0: Bool;
+    override @1: Bool;
+    speedOverride @2: Float32;
+    accelOverride @3: Float32;
+  }
+
+  struct HUDControl {
+    speedVisible @0: Bool;
+    setSpeed @1: Float32;
+    lanesVisible @2: Bool;
+    leadVisible @3: Bool;
+    visualAlert @4: VisualAlert;
+    audibleAlert @5: AudibleAlert;
+    rightLaneVisible @6: Bool;
+    leftLaneVisible @7: Bool;
+    rightLaneDepart @8: Bool;
+    leftLaneDepart @9: Bool;
+
+    enum VisualAlert {
+      # these are the choices from the Honda
+      # map as good as you can for your car
+      none @0;
+      fcw @1;
+      steerRequired @2;
+      brakePressed @3;
+      wrongGear @4;
+      seatbeltUnbuckled @5;
+      speedTooHigh @6;
+    }
+
+    enum AudibleAlert {
+      # these are the choices from the Honda
+      # map as good as you can for your car
+      none @0;
+      chimeEngage @1;
+      chimeDisengage @2;
+      chimeError @3;
+      chimeWarning1 @4;
+      chimeWarning2 @5;
+      chimeWarningRepeat @6;
+      chimePrompt @7;
+    }
+  }
+}
+
+# ****** car param ******
+
+struct CarParams {
+  carName @0 :Text;
+  carFingerprint @1 :Text;
+
+  enableGasInterceptor @2 :Bool;
+  enableCruise @3 :Bool;
+  enableCamera @4 :Bool;
+  enableDsu @5 :Bool; # driving support unit
+  enableApgs @6 :Bool; # advanced parking guidance system
+
+  minEnableSpeed @7 :Float32;
+  minSteerSpeed @8 :Float32;
+  safetyModel @9 :Int16;
+  safetyParam @10 :Int16;
+
+  steerMaxBP @11 :List(Float32);
+  steerMaxV @12 :List(Float32);
+  gasMaxBP @13 :List(Float32);
+  gasMaxV @14 :List(Float32);
+  brakeMaxBP @15 :List(Float32);
+  brakeMaxV @16 :List(Float32);
+
+
+  # things about the car in the manual
+  mass @17 :Float32;             # [kg] running weight
+  wheelbase @18 :Float32;        # [m] distance from rear to front axle
+  centerToFront @19 :Float32;   # [m] GC distance to front axle
+  steerRatio @20 :Float32;       # [] ratio between front wheels and steering wheel angles
+  steerRatioRear @21 :Float32;  # [] rear steering ratio wrt front steering (usually 0)
+
+  # things we can derive
+  rotationalInertia @22 :Float32;    # [kg*m2] body rotational inertia
+  tireStiffnessFront @23 :Float32;   # [N/rad] front tire coeff of stiff
+  tireStiffnessRear @24 :Float32;    # [N/rad] rear tire coeff of stiff
+
+  longitudinalTuning @25 :LongitudinalPIDTuning;
+  lateralTuning :union {
+    pid @26 :LateralPIDTuning;
+    indi @27 :LateralINDITuning;
+  }
+
+  steerLimitAlert @28 :Bool;
+
+  vEgoStopping @29 :Float32; # Speed at which the car goes into stopping state
+  directAccelControl @30 :Bool; # Does the car have direct accel control or just gas/brake
+  stoppingControl @31 :Bool; # Does the car allows full control even at lows speeds when stopping
+  startAccel @32 :Float32; # Required acceleraton to overcome creep braking
+  steerRateCost @33 :Float32; # Lateral MPC cost on steering rate
+  steerControlType @34 :SteerControlType;
+  radarOffCan @35 :Bool; # True when radar objects aren't visible on CAN
+
+  steerActuatorDelay @36 :Float32; # Steering wheel actuator delay in seconds
+  openpilotLongitudinalControl @37 :Bool; # is openpilot doing the longitudinal control?
+
+  struct LateralPIDTuning {
+    kpBP @0 :List(Float32);
+    kpV @1 :List(Float32);
+    kiBP @2 :List(Float32);
+    kiV @3 :List(Float32);
+    kf @4 :Float32;
+  }
+
+  struct LongitudinalPIDTuning {
+    kpBP @0 :List(Float32);
+    kpV @1 :List(Float32);
+    kiBP @2 :List(Float32);
+    kiV @3 :List(Float32);
+    deadzoneBP @4 :List(Float32);
+    deadzoneV @5 :List(Float32);
+  }
+
+
+  struct LateralINDITuning {
+    outerLoopGain @0 :Float32;
+    innerLoopGain @1 :Float32;
+    timeConstant @2 :Float32;
+    actuatorEffectiveness @3 :Float32;
+  }
+
+
+  enum SafetyModels {
+    # does NOT match board setting
+    noOutput @0;
+    honda @1;
+    toyota @2;
+    elm327 @3;
+    gm @4;
+    hondaBosch @5;
+    ford @6;
+    cadillac @7;
+    hyundai @8;
+    chrysler @9;
+    tesla @10;
+    subaru @11;
+  }
+
+  enum SteerControlType {
+    torque @0;
+    angle @1;
+  }
+}

cereal/custom.capnp

@@ -1,79 +0,0 @@
-using Cxx = import "./include/c++.capnp";
-$Cxx.namespace("cereal");
-
-@0xb526ba661d550a59;
-
-# custom.capnp: a home for empty structs reserved for custom forks
-# These structs are guaranteed to remain reserved and empty in mainline
-# cereal, so use these if you want custom events in your fork.
-
-# DO rename the structs
-# DON'T change the identifier (e.g. @0x81c2f05a394cf4af)
-
-struct ControlsStateExt @0x81c2f05a394cf4af {
-  alkaActive @0 :Bool;
-}
-
-struct CarStateExt @0xaedffd8f31e7b55d {
-  # dp - ALKA: lkasOn state from carstate (mirrors panda's lkas_on)
-  lkasOn @0 :Bool;
-}
-
-struct ModelExt @0xf35cc4560bbf6ec2 {
-  leftEdgeDetected @0 :Bool;
-  rightEdgeDetected @1 :Bool;
-}
-
-struct DashyState @0xda96579883444c35 {
-  # Pre-serialized JSON bytes for dashy UI
-  # Aggregates all topics needed by dashy into single message
-  json @0 :Data;
-}
-
-struct CustomReserved4 @0x80ae746ee2596b11 {
-}
-
-struct CustomReserved5 @0xa5cd762cd951a455 {
-}
-
-struct CustomReserved6 @0xf98d843bfd7004a3 {
-}
-
-struct CustomReserved7 @0xb86e6369214c01c8 {
-}
-
-struct CustomReserved8 @0xf416ec09499d9d19 {
-}
-
-struct CustomReserved9 @0xa1680744031fdb2d {
-}
-
-struct CustomReserved10 @0xcb9fd56c7057593a {
-}
-
-struct CustomReserved11 @0xc2243c65e0340384 {
-}
-
-struct CustomReserved12 @0x9ccdc8676701b412 {
-}
-
-struct CustomReserved13 @0xcd96dafb67a082d0 {
-}
-
-struct CustomReserved14 @0xb057204d7deadf3f {
-}
-
-struct CustomReserved15 @0xbd443b539493bc68 {
-}
-
-struct CustomReserved16 @0xfc6241ed8877b611 {
-}
-
-struct CustomReserved17 @0xa30662f84033036c {
-}
-
-struct CustomReserved18 @0xc86a3d38d13eb3ef {
-}
-
-struct CustomReserved19 @0xa4f1eb3323f5f582 {
-}

cereal/include/java.capnp

@@ -0,0 +1,28 @@
+# Copyright (c) 2013-2015 Sandstorm Development Group, Inc. and contributors
+# Licensed under the MIT License:
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+@0xc5f1af96651f70ea;
+
+annotation package @0x9ee4c8f803b3b596 (file) : Text;
+# Name of the package, such as "org.example.foo", in which the generated code will reside.
+
+annotation outerClassname @0x9b066bb4881f7cd3 (file) : Text;
+# Name of the outer class that will wrap the generated code.

cereal/legacy.capnp

@@ -1,574 +0,0 @@
-using Cxx = import "./include/c++.capnp";
-$Cxx.namespace("cereal");
-
-@0x80ef1ec4889c2a63;
-
-# legacy.capnp: a home for deprecated structs
-
-struct LogRotate @0x9811e1f38f62f2d1 {
-  segmentNum @0 :Int32;
-  path @1 :Text;
-}
-
-struct LiveUI @0xc08240f996aefced {
-  rearViewCam @0 :Bool;
-  alertText1 @1 :Text;
-  alertText2 @2 :Text;
-  awarenessStatus @3 :Float32;
-}
-
-struct UiLayoutState @0x88dcce08ad29dda0 {
-  activeApp @0 :App;
-  sidebarCollapsed @1 :Bool;
-  mapEnabled @2 :Bool;
-  mockEngaged @3 :Bool;
-
-  enum App @0x9917470acf94d285 {
-    home @0;
-    music @1;
-    nav @2;
-    settings @3;
-    none @4;
-  }
-}
-
-struct OrbslamCorrection @0x8afd33dc9b35e1aa {
-  correctionMonoTime @0 :UInt64;
-  prePositionECEF @1 :List(Float64);
-  postPositionECEF @2 :List(Float64);
-  prePoseQuatECEF @3 :List(Float32);
-  postPoseQuatECEF @4 :List(Float32);
-  numInliers @5 :UInt32;
-}
-
-struct EthernetPacket @0xa99a9d5b33cf5859 {
-  pkt @0 :Data;
-  ts @1 :Float32;
-}
-
-struct CellInfo @0xcff7566681c277ce {
-  timestamp @0 :UInt64;
-  repr @1 :Text; # android toString() for now
-}
-
-struct WifiScan @0xd4df5a192382ba0b {
-  bssid @0 :Text;
-  ssid @1 :Text;
-  capabilities @2 :Text;
-  frequency @3 :Int32;
-  level @4 :Int32;
-  timestamp @5 :Int64;
-
-  centerFreq0 @6 :Int32;
-  centerFreq1 @7 :Int32;
-  channelWidth @8 :ChannelWidth;
-  operatorFriendlyName @9 :Text;
-  venueName @10 :Text;
-  is80211mcResponder @11 :Bool;
-  passpoint @12 :Bool;
-
-  distanceCm @13 :Int32;
-  distanceSdCm @14 :Int32;
-
-  enum ChannelWidth @0xcb6a279f015f6b51 {
-    w20Mhz @0;
-    w40Mhz @1;
-    w80Mhz @2;
-    w160Mhz @3;
-    w80Plus80Mhz @4;
-  }
-}
-
-struct LiveEventData @0x94b7baa90c5c321e {
-  name @0 :Text;
-  value @1 :Int32;
-}
-
-struct ModelData @0xb8aad62cffef28a9 {
-  frameId @0 :UInt32;
-  frameAge @12 :UInt32;
-  frameDropPerc @13 :Float32;
-  timestampEof @9 :UInt64;
-  modelExecutionTime @14 :Float32;
-  gpuExecutionTime @16 :Float32;
-  rawPred @15 :Data;
-
-  path @1 :PathData;
-  leftLane @2 :PathData;
-  rightLane @3 :PathData;
-  lead @4 :LeadData;
-  freePath @6 :List(Float32);
-
-  settings @5 :ModelSettings;
-  leadFuture @7 :LeadData;
-  speed @8 :List(Float32);
-  meta @10 :MetaData;
-  longitudinal @11 :LongitudinalData;
-
-  struct PathData @0x8817eeea389e9f08 {
-    points @0 :List(Float32);
-    prob @1 :Float32;
-    std @2 :Float32;
-    stds @3 :List(Float32);
-    poly @4 :List(Float32);
-    validLen @5 :Float32;
-  }
-
-  struct LeadData @0xd1c9bef96d26fa91 {
-    dist @0 :Float32;
-    prob @1 :Float32;
-    std @2 :Float32;
-    relVel @3 :Float32;
-    relVelStd @4 :Float32;
-    relY @5 :Float32;
-    relYStd @6 :Float32;
-    relA @7 :Float32;
-    relAStd @8 :Float32;
-  }
-
-  struct ModelSettings @0xa26e3710efd3e914 {
-    bigBoxX @0 :UInt16;
-    bigBoxY @1 :UInt16;
-    bigBoxWidth @2 :UInt16;
-    bigBoxHeight @3 :UInt16;
-    boxProjection @4 :List(Float32);
-    yuvCorrection @5 :List(Float32);
-    inputTransform @6 :List(Float32);
-  }
-
-  struct MetaData @0x9744f25fb60f2bf8 {
-    engagedProb @0 :Float32;
-    desirePrediction @1 :List(Float32);
-    brakeDisengageProb @2 :Float32;
-    gasDisengageProb @3 :Float32;
-    steerOverrideProb @4 :Float32;
-    desireState @5 :List(Float32);
-  }
-
-  struct LongitudinalData @0xf98f999c6a071122 {
-    distances @2 :List(Float32);
-    speeds @0 :List(Float32);
-    accelerations @1 :List(Float32);
-  }
-}
-
-struct ECEFPoint @0xc25bbbd524983447 {
-  x @0 :Float64;
-  y @1 :Float64;
-  z @2 :Float64;
-}
-
-struct ECEFPointDEPRECATED @0xe10e21168db0c7f7 {
-  x @0 :Float32;
-  y @1 :Float32;
-  z @2 :Float32;
-}
-
-struct GPSPlannerPoints @0xab54c59699f8f9f3 {
-  curPosDEPRECATED @0 :ECEFPointDEPRECATED;
-  pointsDEPRECATED @1 :List(ECEFPointDEPRECATED);
-  curPos @6 :ECEFPoint;
-  points @7 :List(ECEFPoint);
-  valid @2 :Bool;
-  trackName @3 :Text;
-  speedLimit @4 :Float32;
-  accelTarget @5 :Float32;
-}
-
-struct GPSPlannerPlan @0xf5ad1d90cdc1dd6b {
-  valid @0 :Bool;
-  poly @1 :List(Float32);
-  trackName @2 :Text;
-  speed @3 :Float32;
-  acceleration @4 :Float32;
-  pointsDEPRECATED @5 :List(ECEFPointDEPRECATED);
-  points @6 :List(ECEFPoint);
-  xLookahead @7 :Float32;
-}
-
-struct UiNavigationEvent @0x90c8426c3eaddd3b {
-  type @0: Type;
-  status @1: Status;
-  distanceTo @2: Float32;
-  endRoadPointDEPRECATED @3: ECEFPointDEPRECATED;
-  endRoadPoint @4: ECEFPoint;
-
-  enum Type @0xe8db07dcf8fcea05 {
-    none @0;
-    laneChangeLeft @1;
-    laneChangeRight @2;
-    mergeLeft @3;
-    mergeRight @4;
-    turnLeft @5;
-    turnRight @6;
-  }
-
-  enum Status @0xb9aa88c75ef99a1f {
-    none @0;
-    passive @1;
-    approaching @2;
-    active @3;
-  }
-}
-
-struct LiveLocationData @0xb99b2bc7a57e8128 {
-  status @0 :UInt8;
-
-  # 3D fix
-  lat @1 :Float64;
-  lon @2 :Float64;
-  alt @3 :Float32;     # m
-
-  # speed
-  speed @4 :Float32;   # m/s
-
-  # NED velocity components
-  vNED @5 :List(Float32);
-
-  # roll, pitch, heading (x,y,z)
-  roll @6 :Float32;     # WRT to center of earth?
-  pitch @7 :Float32;    # WRT to center of earth?
-  heading @8 :Float32;  # WRT to north?
-
-  # what are these?
-  wanderAngle @9 :Float32;
-  trackAngle @10 :Float32;
-
-  # car frame -- https://upload.wikimedia.org/wikipedia/commons/f/f5/RPY_angles_of_cars.png
-
-  # gyro, in car frame, deg/s
-  gyro @11 :List(Float32);
-
-  # accel, in car frame, m/s^2
-  accel @12 :List(Float32);
-
-  accuracy @13 :Accuracy;
-
-  source @14 :SensorSource;
-  # if we are fixing a location in the past
-  fixMonoTime @15 :UInt64;
-
-  gpsWeek @16 :Int32;
-  timeOfWeek @17 :Float64;
-
-  positionECEF @18 :List(Float64);
-  poseQuatECEF @19 :List(Float32);
-  pitchCalibration @20 :Float32;
-  yawCalibration @21 :Float32;
-  imuFrame @22 :List(Float32);
-
-  struct Accuracy @0x943dc4625473b03f {
-    pNEDError @0 :List(Float32);
-    vNEDError @1 :List(Float32);
-    rollError @2 :Float32;
-    pitchError @3 :Float32;
-    headingError @4 :Float32;
-    ellipsoidSemiMajorError @5 :Float32;
-    ellipsoidSemiMinorError @6 :Float32;
-    ellipsoidOrientationError @7 :Float32;
-  }
-
-  enum SensorSource @0xc871d3cc252af657 {
-    applanix @0;
-    kalman @1;
-    orbslam @2;
-    timing @3;
-    dummy @4;
-  }
-}
-
-struct OrbOdometry @0xd7700859ed1f5b76 {
-  # timing first
-  startMonoTime @0 :UInt64;
-  endMonoTime @1 :UInt64;
-
-  # fundamental matrix and error
-  f @2: List(Float64);
-  err @3: Float64;
-
-  # number of inlier points
-  inliers @4: Int32;
-
-  # for debug only
-  # indexed by endMonoTime features
-  # value is startMonoTime feature match
-  # -1 if no match
-  matches @5: List(Int16);
-}
-
-struct OrbFeatures @0xcd60164a8a0159ef {
-  timestampEof @0 :UInt64;
-  # transposed arrays of normalized image coordinates
-  # len(xs) == len(ys) == len(descriptors) * 32
-  xs @1 :List(Float32);
-  ys @2 :List(Float32);
-  descriptors @3 :Data;
-  octaves @4 :List(Int8);
-
-  # match index to last OrbFeatures
-  # -1 if no match
-  timestampLastEof @5 :UInt64;
-  matches @6: List(Int16);
-}
-
-struct OrbFeaturesSummary @0xd500d30c5803fa4f {
-  timestampEof @0 :UInt64;
-  timestampLastEof @1 :UInt64;
-
-  featureCount @2 :UInt16;
-  matchCount @3 :UInt16;
-  computeNs @4 :UInt64;
-}
-
-struct OrbKeyFrame @0xc8233c0345e27e24 {
-  # this is a globally unique id for the KeyFrame
-  id @0: UInt64;
-
-  # this is the location of the KeyFrame
-  pos @1: ECEFPoint;
-
-  # these are the features in the world
-  # len(dpos) == len(descriptors) * 32
-  dpos @2 :List(ECEFPoint);
-  descriptors @3 :Data;
-}
-
-struct KalmanOdometry @0x92e21bb7ea38793a {
-  trans @0 :List(Float32); # m/s in device frame
-  rot @1 :List(Float32); # rad/s in device frame
-  transStd @2 :List(Float32); # std m/s in device frame
-  rotStd @3 :List(Float32); # std rad/s in device frame
-}
-
-struct OrbObservation @0x9b326d4e436afec7 {
-  observationMonoTime @0 :UInt64;
-  normalizedCoordinates @1 :List(Float32);
-  locationECEF @2 :List(Float64);
-  matchDistance @3: UInt32;
-}
-
-struct CalibrationFeatures @0x8fdfadb254ea867a {
-  frameId @0 :UInt32;
-
-  p0 @1 :List(Float32);
-  p1 @2 :List(Float32);
-  status @3 :List(Int8);
-}
-
-struct NavStatus @0xbd8822120928120c {
-  isNavigating @0 :Bool;
-  currentAddress @1 :Address;
-
-  struct Address @0xce7cd672cacc7814 {
-    title @0 :Text;
-    lat @1 :Float64;
-    lng @2 :Float64;
-    house @3 :Text;
-    address @4 :Text;
-    street @5 :Text;
-    city @6 :Text;
-    state @7 :Text;
-    country @8 :Text;
-  }
-}
-
-struct NavUpdate @0xdb98be6565516acb {
-  isNavigating @0 :Bool;
-  curSegment @1 :Int32;
-  segments @2 :List(Segment);
-
-  struct LatLng @0x9eaef9187cadbb9b {
-    lat @0 :Float64;
-    lng @1 :Float64;
-  }
-
-  struct Segment @0xa5b39b4fc4d7da3f {
-    from @0 :LatLng;
-    to @1 :LatLng;
-    updateTime @2 :Int32;
-    distance @3 :Int32;
-    crossTime @4 :Int32;
-    exitNo @5 :Int32;
-    instruction @6 :Instruction;
-
-    parts @7 :List(LatLng);
-
-    enum Instruction @0xc5417a637451246f {
-      turnLeft @0;
-      turnRight @1;
-      keepLeft @2;
-      keepRight @3;
-      straight @4;
-      roundaboutExitNumber @5;
-      roundaboutExit @6;
-      roundaboutTurnLeft @7;
-      unkn8 @8;
-      roundaboutStraight @9;
-      unkn10 @10;
-      roundaboutTurnRight @11;
-      unkn12 @12;
-      roundaboutUturn @13;
-      unkn14 @14;
-      arrive @15;
-      exitLeft @16;
-      exitRight @17;
-      unkn18 @18;
-      uturn @19;
-      # ...
-    }
-  }
-}
-
-struct TrafficEvent @0xacfa74a094e62626 {
-  type @0 :Type;
-  distance @1 :Float32;
-  action @2 :Action;
-  resuming @3 :Bool;
-
-  enum Type @0xd85d75253435bf4b {
-    stopSign @0;
-    lightRed @1;
-    lightYellow @2;
-    lightGreen @3;
-    stopLight @4;
-  }
-
-  enum Action @0xa6f6ce72165ccb49 {
-    none @0;
-    yield @1;
-    stop @2;
-    resumeReady @3;
-  }
-
-}
-
-
-struct AndroidGnss @0xdfdf30d03fc485bd {
-  union {
-    measurements @0 :Measurements;
-    navigationMessage @1 :NavigationMessage;
-  }
-
-  struct Measurements @0xa20710d4f428d6cd {
-    clock @0 :Clock;
-    measurements @1 :List(Measurement);
-
-    struct Clock @0xa0e27b453a38f450 {
-      timeNanos @0 :Int64;
-      hardwareClockDiscontinuityCount @1 :Int32;
-
-      hasTimeUncertaintyNanos @2 :Bool;
-      timeUncertaintyNanos @3 :Float64;
-
-      hasLeapSecond @4 :Bool;
-      leapSecond @5 :Int32;
-
-      hasFullBiasNanos @6 :Bool;
-      fullBiasNanos @7 :Int64;
-
-      hasBiasNanos @8 :Bool;
-      biasNanos @9 :Float64;
-
-      hasBiasUncertaintyNanos @10 :Bool;
-      biasUncertaintyNanos @11 :Float64;
-
-      hasDriftNanosPerSecond @12 :Bool;
-      driftNanosPerSecond @13 :Float64;
-
-      hasDriftUncertaintyNanosPerSecond @14 :Bool;
-      driftUncertaintyNanosPerSecond @15 :Float64;
-    }
-
-    struct Measurement @0xd949bf717d77614d {
-      svId @0 :Int32;
-      constellation @1 :Constellation;
-
-      timeOffsetNanos @2 :Float64;
-      state @3 :Int32;
-      receivedSvTimeNanos @4 :Int64;
-      receivedSvTimeUncertaintyNanos @5 :Int64;
-      cn0DbHz @6 :Float64;
-      pseudorangeRateMetersPerSecond @7 :Float64;
-      pseudorangeRateUncertaintyMetersPerSecond @8 :Float64;
-      accumulatedDeltaRangeState @9 :Int32;
-      accumulatedDeltaRangeMeters @10 :Float64;
-      accumulatedDeltaRangeUncertaintyMeters @11 :Float64;
-
-      hasCarrierFrequencyHz @12 :Bool;
-      carrierFrequencyHz @13 :Float32;
-      hasCarrierCycles @14 :Bool;
-      carrierCycles @15 :Int64;
-      hasCarrierPhase @16 :Bool;
-      carrierPhase @17 :Float64;
-      hasCarrierPhaseUncertainty @18 :Bool;
-      carrierPhaseUncertainty @19 :Float64;
-      hasSnrInDb @20 :Bool;
-      snrInDb @21 :Float64;
-
-      multipathIndicator @22 :MultipathIndicator;
-
-      enum Constellation @0x9ef1f3ff0deb5ffb {
-        unknown @0;
-        gps @1;
-        sbas @2;
-        glonass @3;
-        qzss @4;
-        beidou @5;
-        galileo @6;
-      }
-
-      enum State @0xcbb9490adce12d72 {
-        unknown @0;
-        codeLock @1;
-        bitSync @2;
-        subframeSync @3;
-        towDecoded @4;
-        msecAmbiguous @5;
-        symbolSync @6;
-        gloStringSync @7;
-        gloTodDecoded @8;
-        bdsD2BitSync @9;
-        bdsD2SubframeSync @10;
-        galE1bcCodeLock @11;
-        galE1c2ndCodeLock @12;
-        galE1bPageSync @13;
-        sbasSync @14;
-      }
-
-      enum MultipathIndicator @0xc04e7b6231d4caa8 {
-        unknown @0;
-        detected @1;
-        notDetected @2;
-      }
-    }
-  }
-
-  struct NavigationMessage @0xe2517b083095fd4e {
-    type @0 :Int32;
-    svId @1 :Int32;
-    messageId @2 :Int32;
-    submessageId @3 :Int32;
-    data @4 :Data;
-    status @5 :Status;
-
-    enum Status @0xec1ff7996b35366f {
-      unknown @0;
-      parityPassed @1;
-      parityRebuilt @2;
-    }
-  }
-}
-
-struct LidarPts @0xe3d6685d4e9d8f7a {
-  r @0 :List(UInt16);        # uint16   m*500.0
-  theta @1 :List(UInt16);    # uint16 deg*100.0
-  reflect @2 :List(UInt8);   # uint8      0-255
-
-  # For storing out of file.
-  idx @3 :UInt64;
-
-  # For storing in file
-  pkt @4 :Data;
-}
-
-

cereal/messaging/__init__.py

@@ -1,269 +0,0 @@
-# must be built with scons
-from msgq import fake_event_handle, drain_sock_raw, MultiplePublishersError, IpcError, \
-                 Context, Poller, SubSocket, PubSocket, SocketEventHandle, toggle_fake_events, \
-                 set_fake_prefix, get_fake_prefix, delete_fake_prefix, wait_for_one_event
-import msgq
-import os
-import capnp
-import time
-
-from typing import Optional, List, Union, Dict
-
-from cereal import log
-from cereal.services import SERVICE_LIST
-from openpilot.common.utils import MovingAverage
-
-NO_TRAVERSAL_LIMIT = 2**64-1
-
-
-def pub_sock(endpoint: str) -> PubSocket:
-  service = SERVICE_LIST.get(endpoint)
-  segment_size = service.queue_size if service else 0
-  return msgq.pub_sock(endpoint, segment_size)
-
-
-def sub_sock(endpoint: str, poller: Optional[Poller] = None, addr: str = "127.0.0.1",
-             conflate: bool = False, timeout: Optional[int] = None) -> SubSocket:
-  service = SERVICE_LIST.get(endpoint)
-  segment_size = service.queue_size if service else 0
-  return msgq.sub_sock(endpoint, poller=poller, addr=addr, conflate=conflate,
-                       timeout=timeout, segment_size=segment_size)
-
-
-def reset_context():
-  msgq.context = Context()
-
-
-def log_from_bytes(dat: bytes, struct: capnp.lib.capnp._StructModule = log.Event) -> capnp.lib.capnp._DynamicStructReader:
-  with struct.from_bytes(dat, traversal_limit_in_words=NO_TRAVERSAL_LIMIT) as msg:
-    return msg
-
-
-def new_message(service: Optional[str], size: Optional[int] = None, **kwargs) -> capnp.lib.capnp._DynamicStructBuilder:
-  args = {
-    'valid': False,
-    'logMonoTime': int(time.monotonic() * 1e9),
-    **kwargs
-  }
-  dat = log.Event.new_message(**args)
-  if service is not None:
-    if size is None:
-      dat.init(service)
-    else:
-      dat.init(service, size)
-  return dat
-
-
-def drain_sock(sock: SubSocket, wait_for_one: bool = False) -> List[capnp.lib.capnp._DynamicStructReader]:
-  """Receive all message currently available on the queue"""
-  msgs = drain_sock_raw(sock, wait_for_one=wait_for_one)
-  return [log_from_bytes(m) for m in msgs]
-
-
-# TODO: print when we drop packets?
-def recv_sock(sock: SubSocket, wait: bool = False) -> Optional[capnp.lib.capnp._DynamicStructReader]:
-  """Same as drain sock, but only returns latest message. Consider using conflate instead."""
-  dat = None
-
-  while 1:
-    if wait and dat is None:
-      recv = sock.receive()
-    else:
-      recv = sock.receive(non_blocking=True)
-
-    if recv is None:  # Timeout hit
-      break
-
-    dat = recv
-
-  if dat is not None:
-    dat = log_from_bytes(dat)
-
-  return dat
-
-
-def recv_one(sock: SubSocket) -> Optional[capnp.lib.capnp._DynamicStructReader]:
-  dat = sock.receive()
-  if dat is not None:
-    dat = log_from_bytes(dat)
-  return dat
-
-
-def recv_one_or_none(sock: SubSocket) -> Optional[capnp.lib.capnp._DynamicStructReader]:
-  dat = sock.receive(non_blocking=True)
-  if dat is not None:
-    dat = log_from_bytes(dat)
-  return dat
-
-
-def recv_one_retry(sock: SubSocket) -> capnp.lib.capnp._DynamicStructReader:
-  """Keep receiving until we get a message"""
-  while True:
-    dat = sock.receive()
-    if dat is not None:
-      return log_from_bytes(dat)
-
-
-class FrequencyTracker:
-  def __init__(self, service_freq: float, update_freq: float, is_poll: bool):
-    freq = max(min(service_freq, update_freq), 1.)
-    if is_poll:
-      min_freq = max_freq = freq
-    else:
-      max_freq = min(freq, update_freq)
-      if service_freq >= 2 * update_freq:
-        min_freq = update_freq
-      elif update_freq >= 2* service_freq:
-        min_freq = freq
-      else:
-        min_freq = min(freq, freq / 2.)
-
-    self.min_freq = min_freq * 0.8
-    self.max_freq = max_freq * 1.2
-    self.avg_dt = MovingAverage(int(10 * freq))
-    self.recent_avg_dt = MovingAverage(int(freq))
-    self.prev_time = 0.0
-
-  def record_recv_time(self, cur_time: float) -> None:
-    # TODO: Handle case where cur_time is less than prev_time
-    if self.prev_time > 1e-5:
-      dt = cur_time - self.prev_time
-
-      self.avg_dt.add_value(dt)
-      self.recent_avg_dt.add_value(dt)
-
-    self.prev_time = cur_time
-
-  @property
-  def valid(self) -> bool:
-    if self.avg_dt.count == 0:
-      return False
-
-    avg_freq = 1.0 / self.avg_dt.get_average()
-    if self.min_freq <= avg_freq <= self.max_freq:
-      return True
-
-    avg_freq_recent = 1.0 / self.recent_avg_dt.get_average()
-    return self.min_freq <= avg_freq_recent <= self.max_freq
-
-
-class SubMaster:
-  def __init__(self, services: List[str], poll: Optional[str] = None,
-               ignore_alive: Optional[List[str]] = None, ignore_avg_freq: Optional[List[str]] = None,
-               ignore_valid: Optional[List[str]] = None, addr: str = "127.0.0.1", frequency: Optional[float] = None):
-    self.frame = -1
-    self.services = services
-    self.seen = {s: False for s in services}
-    self.updated = {s: False for s in services}
-    self.recv_time = {s: 0. for s in services}
-    self.recv_frame = {s: 0 for s in services}
-    self.sock = {}
-    self.data = {}
-    self.logMonoTime = {s: 0 for s in services}
-
-    # zero-frequency / on-demand services are always alive and presumed valid; all others must pass checks
-    on_demand = {s: SERVICE_LIST[s].frequency <= 1e-5 for s in services}
-    self.static_freq_services = set(s for s in services if not on_demand[s])
-    self.alive = {s: on_demand[s] for s in services}
-    self.freq_ok = {s: on_demand[s] for s in services}
-    self.valid = {s: on_demand[s] for s in services}
-
-    self.freq_tracker: Dict[str, FrequencyTracker] = {}
-    self.poller = Poller()
-    polled_services = set([poll, ] if poll is not None else services)
-    self.non_polled_services = set(services) - polled_services
-
-    self.ignore_average_freq = [] if ignore_avg_freq is None else ignore_avg_freq
-    self.ignore_alive = [] if ignore_alive is None else ignore_alive
-    self.ignore_valid = [] if ignore_valid is None else ignore_valid
-
-    self.simulation = bool(int(os.getenv("SIMULATION", "0")))
-
-    # if freq and poll aren't specified, assume the max to be conservative
-    assert frequency is None or poll is None, "Do not specify 'frequency' - frequency of the polled service will be used."
-    self.update_freq = frequency or max([SERVICE_LIST[s].frequency for s in polled_services])
-
-    for s in services:
-      p = self.poller if s not in self.non_polled_services else None
-      self.sock[s] = sub_sock(s, poller=p, addr=addr, conflate=True)
-
-      try:
-        data = new_message(s)
-      except capnp.lib.capnp.KjException:
-        data = new_message(s, 0) # lists
-
-      self.data[s] = getattr(data.as_reader(), s)
-      self.freq_tracker[s] = FrequencyTracker(SERVICE_LIST[s].frequency, self.update_freq, s == poll)
-
-  def __getitem__(self, s: str) -> capnp.lib.capnp._DynamicStructReader:
-    return self.data[s]
-
-  def _check_avg_freq(self, s: str) -> bool:
-    return SERVICE_LIST[s].frequency > 0.99 and (s not in self.ignore_average_freq) and (s not in self.ignore_alive)
-
-  def update(self, timeout: int = 100) -> None:
-    msgs = []
-    for sock in self.poller.poll(timeout):
-      msgs.append(recv_one_or_none(sock))
-
-    # non-blocking receive for non-polled sockets
-    for s in self.non_polled_services:
-      msgs.append(recv_one_or_none(self.sock[s]))
-    self.update_msgs(time.monotonic(), msgs)
-
-  def update_msgs(self, cur_time: float, msgs: List[capnp.lib.capnp._DynamicStructReader]) -> None:
-    self.frame += 1
-    self.updated = dict.fromkeys(self.services, False)
-    for msg in msgs:
-      if msg is None:
-        continue
-
-      s = msg.which()
-      self.seen[s] = True
-      self.updated[s] = True
-
-      self.freq_tracker[s].record_recv_time(cur_time)
-      self.recv_time[s] = cur_time
-      self.recv_frame[s] = self.frame
-      self.data[s] = getattr(msg, s)
-      self.logMonoTime[s] = msg.logMonoTime
-      self.valid[s] = msg.valid
-
-    for s in self.static_freq_services:
-      # alive if delay is within 10x the expected frequency; checks relaxed in simulator
-      self.alive[s] = (cur_time - self.recv_time[s]) < (10. / SERVICE_LIST[s].frequency) or (self.seen[s] and self.simulation)
-      self.freq_ok[s] = self.freq_tracker[s].valid or self.simulation
-
-  def all_alive(self, service_list: Optional[List[str]] = None) -> bool:
-    return all(self.alive[s] for s in (service_list or self.services) if s not in self.ignore_alive)
-
-  def all_freq_ok(self, service_list: Optional[List[str]] = None) -> bool:
-    return all(self.freq_ok[s] for s in (service_list or self.services) if self._check_avg_freq(s))
-
-  def all_valid(self, service_list: Optional[List[str]] = None) -> bool:
-    return all(self.valid[s] for s in (service_list or self.services) if s not in self.ignore_valid)
-
-  def all_checks(self, service_list: Optional[List[str]] = None) -> bool:
-    return self.all_alive(service_list) and self.all_freq_ok(service_list) and self.all_valid(service_list)
-
-
-class PubMaster:
-  def __init__(self, services: List[str]):
-    self.sock = {}
-    for s in services:
-      self.sock[s] = pub_sock(s)
-
-  def send(self, s: str, dat: Union[bytes, capnp.lib.capnp._DynamicStructBuilder]) -> None:
-    if not isinstance(dat, bytes):
-      dat = dat.to_bytes()
-    self.sock[s].send(dat)
-
-  def wait_for_readers_to_update(self, s: str, timeout: int, dt: float = 0.05) -> bool:
-    for _ in range(int(timeout*(1./dt))):
-      if self.sock[s].all_readers_updated():
-        return True
-      time.sleep(dt)
-    return False
-
-  def all_readers_updated(self, s: str) -> bool:
-    return self.sock[s].all_readers_updated()  # type: ignore

cereal/messaging/bridge.cc

@@ -1,72 +0,0 @@
-#include <cassert>
-
-#include "cereal/messaging/msgq_to_zmq.h"
-#include "cereal/services.h"
-#include "common/util.h"
-
-ExitHandler do_exit;
-
-static std::vector<std::string> get_services(const std::string &whitelist_str, bool zmq_to_msgq) {
-  std::vector<std::string> service_list;
-  for (const auto& it : services) {
-    std::string name = it.second.name;
-    bool in_whitelist = whitelist_str.find(name) != std::string::npos;
-    if (zmq_to_msgq && !in_whitelist) {
-      continue;
-    }
-    service_list.push_back(name);
-  }
-  return service_list;
-}
-
-void msgq_to_zmq(const std::vector<std::string> &endpoints, const std::string &ip) {
-  MsgqToZmq bridge;
-  bridge.run(endpoints, ip);
-}
-
-void zmq_to_msgq(const std::vector<std::string> &endpoints, const std::string &ip) {
-  auto poller = std::make_unique<BridgeZmqPoller>();
-  auto pub_context = std::make_unique<Context>();
-  auto sub_context = std::make_unique<BridgeZmqContext>();
-  std::map<BridgeZmqSubSocket *, PubSocket *> sub2pub;
-
-  for (auto endpoint : endpoints) {
-    auto pub_sock = new PubSocket();
-    auto sub_sock = new BridgeZmqSubSocket();
-    size_t queue_size = services.at(endpoint).queue_size;
-    pub_sock->connect(pub_context.get(), endpoint, true, queue_size);
-    sub_sock->connect(sub_context.get(), endpoint, ip, false);
-
-    poller->registerSocket(sub_sock);
-    sub2pub[sub_sock] = pub_sock;
-  }
-
-  while (!do_exit) {
-    for (auto sub_sock : poller->poll(100)) {
-      std::unique_ptr<Message> msg(sub_sock->receive(true));
-      if (msg) {
-        sub2pub[sub_sock]->sendMessage(msg.get());
-      }
-    }
-  }
-
-  // Clean up allocated sockets
-  for (auto &[sub_sock, pub_sock] : sub2pub) {
-    delete sub_sock;
-    delete pub_sock;
-  }
-}
-
-int main(int argc, char **argv) {
-  bool is_zmq_to_msgq = argc > 2;
-  std::string ip = is_zmq_to_msgq ? argv[1] : "127.0.0.1";
-  std::string whitelist_str = is_zmq_to_msgq ? std::string(argv[2]) : "";
-  std::vector<std::string> endpoints = get_services(whitelist_str, is_zmq_to_msgq);
-
-  if (is_zmq_to_msgq) {
-    zmq_to_msgq(endpoints, ip);
-  } else {
-    msgq_to_zmq(endpoints, ip);
-  }
-  return 0;
-}

cereal/messaging/bridge_zmq.cc

@@ -1,170 +0,0 @@
-#include "cereal/messaging/bridge_zmq.h"
-
-#include <cassert>
-#include <cstring>
-#include <unistd.h>
-
-static size_t fnv1a_hash(const std::string &str) {
-  const size_t fnv_prime = 0x100000001b3;
-  size_t hash_value = 0xcbf29ce484222325;
-  for (char c : str) {
-    hash_value ^= (unsigned char)c;
-    hash_value *= fnv_prime;
-  }
-  return hash_value;
-}
-
-// FIXME: This is a hack to get the port number from the socket name, might have collisions.
-static int get_port(std::string endpoint) {
-  size_t hash_value = fnv1a_hash(endpoint);
-  int start_port = 8023;
-  int max_port = 65535;
-  return start_port + (hash_value % (max_port - start_port));
-}
-
-BridgeZmqContext::BridgeZmqContext() {
-  context = zmq_ctx_new();
-}
-
-BridgeZmqContext::~BridgeZmqContext() {
-  if (context != nullptr) {
-    zmq_ctx_term(context);
-  }
-}
-
-void BridgeZmqMessage::init(size_t sz) {
-  size = sz;
-  data = new char[size];
-}
-
-void BridgeZmqMessage::init(char *d, size_t sz) {
-  size = sz;
-  data = new char[size];
-  memcpy(data, d, size);
-}
-
-void BridgeZmqMessage::close() {
-  if (size > 0) {
-    delete[] data;
-  }
-  data = nullptr;
-  size = 0;
-}
-
-BridgeZmqMessage::~BridgeZmqMessage() {
-  close();
-}
-
-int BridgeZmqSubSocket::connect(BridgeZmqContext *context, std::string endpoint, std::string address, bool conflate, bool check_endpoint) {
-  sock = zmq_socket(context->getRawContext(), ZMQ_SUB);
-  if (sock == nullptr) {
-    return -1;
-  }
-
-  zmq_setsockopt(sock, ZMQ_SUBSCRIBE, "", 0);
-
-  if (conflate) {
-    int arg = 1;
-    zmq_setsockopt(sock, ZMQ_CONFLATE, &arg, sizeof(int));
-  }
-
-  int reconnect_ivl = 500;
-  zmq_setsockopt(sock, ZMQ_RECONNECT_IVL_MAX, &reconnect_ivl, sizeof(reconnect_ivl));
-
-  full_endpoint = "tcp://" + address + ":";
-  if (check_endpoint) {
-    full_endpoint += std::to_string(get_port(endpoint));
-  } else {
-    full_endpoint += endpoint;
-  }
-
-  return zmq_connect(sock, full_endpoint.c_str());
-}
-
-void BridgeZmqSubSocket::setTimeout(int timeout) {
-  zmq_setsockopt(sock, ZMQ_RCVTIMEO, &timeout, sizeof(int));
-}
-
-Message *BridgeZmqSubSocket::receive(bool non_blocking) {
-  zmq_msg_t msg;
-  assert(zmq_msg_init(&msg) == 0);
-
-  int flags = non_blocking ? ZMQ_DONTWAIT : 0;
-  int rc = zmq_msg_recv(&msg, sock, flags);
-
-  Message *ret = nullptr;
-  if (rc >= 0) {
-    ret = new BridgeZmqMessage;
-    ret->init((char *)zmq_msg_data(&msg), zmq_msg_size(&msg));
-  }
-
-  zmq_msg_close(&msg);
-  return ret;
-}
-
-BridgeZmqSubSocket::~BridgeZmqSubSocket() {
-  if (sock != nullptr) {
-    zmq_close(sock);
-  }
-}
-
-int BridgeZmqPubSocket::connect(BridgeZmqContext *context, std::string endpoint, bool check_endpoint) {
-  sock = zmq_socket(context->getRawContext(), ZMQ_PUB);
-  if (sock == nullptr) {
-    return -1;
-  }
-
-  full_endpoint = "tcp://*:";
-  if (check_endpoint) {
-    full_endpoint += std::to_string(get_port(endpoint));
-  } else {
-    full_endpoint += endpoint;
-  }
-
-  // ZMQ pub sockets cannot be shared between processes, so we need to ensure pid stays the same.
-  pid = getpid();
-
-  return zmq_bind(sock, full_endpoint.c_str());
-}
-
-int BridgeZmqPubSocket::sendMessage(Message *message) {
-  assert(pid == getpid());
-  return zmq_send(sock, message->getData(), message->getSize(), ZMQ_DONTWAIT);
-}
-
-int BridgeZmqPubSocket::send(char *data, size_t size) {
-  assert(pid == getpid());
-  return zmq_send(sock, data, size, ZMQ_DONTWAIT);
-}
-
-BridgeZmqPubSocket::~BridgeZmqPubSocket() {
-  if (sock != nullptr) {
-    zmq_close(sock);
-  }
-}
-
-void BridgeZmqPoller::registerSocket(BridgeZmqSubSocket *socket) {
-  assert(num_polls + 1 < (sizeof(polls) / sizeof(polls[0])));
-  polls[num_polls].socket = socket->getRawSocket();
-  polls[num_polls].events = ZMQ_POLLIN;
-
-  sockets.push_back(socket);
-  num_polls++;
-}
-
-std::vector<BridgeZmqSubSocket *> BridgeZmqPoller::poll(int timeout) {
-  std::vector<BridgeZmqSubSocket *> ret;
-
-  int rc = zmq_poll(polls, num_polls, timeout);
-  if (rc < 0) {
-    return ret;
-  }
-
-  for (size_t i = 0; i < num_polls; i++) {
-    if (polls[i].revents) {
-      ret.push_back(sockets[i]);
-    }
-  }
-
-  return ret;
-}

cereal/messaging/bridge_zmq.h

@@ -1,72 +0,0 @@
-#pragma once
-
-#include <cstddef>
-#include <string>
-#include <vector>
-
-#include <zmq.h>
-
-#include "msgq/ipc.h"
-
-class BridgeZmqContext {
-public:
-  BridgeZmqContext();
-  void *getRawContext() { return context; }
-  ~BridgeZmqContext();
-
-private:
-  void *context = nullptr;
-};
-
-class BridgeZmqMessage : public Message {
-public:
-  void init(size_t size);
-  void init(char *data, size_t size);
-  void close();
-  size_t getSize() { return size; }
-  char *getData() { return data; }
-  ~BridgeZmqMessage();
-
-private:
-  char *data = nullptr;
-  size_t size = 0;
-};
-
-class BridgeZmqSubSocket {
-public:
-  int connect(BridgeZmqContext *context, std::string endpoint, std::string address, bool conflate = false, bool check_endpoint = true);
-  void setTimeout(int timeout);
-  Message *receive(bool non_blocking = false);
-  void *getRawSocket() { return sock; }
-  ~BridgeZmqSubSocket();
-
-private:
-  void *sock = nullptr;
-  std::string full_endpoint;
-};
-
-class BridgeZmqPubSocket {
-public:
-  int connect(BridgeZmqContext *context, std::string endpoint, bool check_endpoint = true);
-  int sendMessage(Message *message);
-  int send(char *data, size_t size);
-  void *getRawSocket() { return sock; }
-  ~BridgeZmqPubSocket();
-
-private:
-  void *sock = nullptr;
-  std::string full_endpoint;
-  int pid = -1;
-};
-
-class BridgeZmqPoller {
-public:
-  void registerSocket(BridgeZmqSubSocket *socket);
-  std::vector<BridgeZmqSubSocket *> poll(int timeout);
-
-private:
-  static constexpr size_t MAX_BRIDGE_ZMQ_POLLERS = 128;
-  std::vector<BridgeZmqSubSocket *> sockets;
-  zmq_pollitem_t polls[MAX_BRIDGE_ZMQ_POLLERS] = {};
-  size_t num_polls = 0;
-};

cereal/messaging/messaging.h

@@ -1,102 +0,0 @@
-#pragma once
-
-#include <cstddef>
-#include <map>
-#include <string>
-#include <vector>
-#include <utility>
-
-#include <capnp/serialize.h>
-
-#include "cereal/gen/cpp/log.capnp.h"
-#include "common/timing.h"
-#include "msgq/ipc.h"
-
-class SubMaster {
-public:
-  SubMaster(const std::vector<const char *> &service_list, const std::vector<const char *> &poll = {},
-            const char *address = nullptr, const std::vector<const char *> &ignore_alive = {});
-  void update(int timeout = 1000);
-  void update_msgs(uint64_t current_time, const std::vector<std::pair<std::string, cereal::Event::Reader>> &messages);
-  inline bool allAlive(const std::vector<const char *> &service_list = {}) { return all_(service_list, false, true); }
-  inline bool allValid(const std::vector<const char *> &service_list = {}) { return all_(service_list, true, false); }
-  inline bool allAliveAndValid(const std::vector<const char *> &service_list = {}) { return all_(service_list, true, true); }
-  void drain();
-  ~SubMaster();
-
-  uint64_t frame = 0;
-  bool updated(const char *name) const;
-  bool alive(const char *name) const;
-  bool valid(const char *name) const;
-  uint64_t rcv_frame(const char *name) const;
-  uint64_t rcv_time(const char *name) const;
-  cereal::Event::Reader &operator[](const char *name) const;
-
-private:
-  bool all_(const std::vector<const char *> &service_list, bool valid, bool alive);
-  Poller *poller_ = nullptr;
-  struct SubMessage;
-  std::map<SubSocket *, SubMessage *> messages_;
-  std::map<std::string, SubMessage *> services_;
-};
-
-class MessageBuilder : public capnp::MallocMessageBuilder {
-public:
-  MessageBuilder() = default;
-
-  cereal::Event::Builder initEvent(bool valid = true) {
-    cereal::Event::Builder event = initRoot<cereal::Event>();
-    event.setLogMonoTime(nanos_since_boot());
-    event.setValid(valid);
-    return event;
-  }
-
-  kj::ArrayPtr<capnp::byte> toBytes() {
-    heapArray_ = capnp::messageToFlatArray(*this);
-    return heapArray_.asBytes();
-  }
-
-  size_t getSerializedSize() {
-    return capnp::computeSerializedSizeInWords(*this) * sizeof(capnp::word);
-  }
-
-  int serializeToBuffer(unsigned char *buffer, size_t buffer_size) {
-    size_t serialized_size = getSerializedSize();
-    if (serialized_size > buffer_size) { return -1; }
-    kj::ArrayOutputStream out(kj::ArrayPtr<capnp::byte>(buffer, buffer_size));
-    capnp::writeMessage(out, *this);
-    return serialized_size;
-  }
-
-private:
-  kj::Array<capnp::word> heapArray_;
-};
-
-class PubMaster {
-public:
-  PubMaster(const std::vector<const char *> &service_list);
-  inline int send(const char *name, capnp::byte *data, size_t size) { return sockets_.at(name)->send((char *)data, size); }
-  int send(const char *name, MessageBuilder &msg);
-  ~PubMaster();
-
-private:
-  std::map<std::string, PubSocket *> sockets_;
-};
-
-class AlignedBuffer {
-public:
-  kj::ArrayPtr<const capnp::word> align(const char *data, const size_t size) {
-    words_size = size / sizeof(capnp::word) + 1;
-    if (aligned_buf.size() < words_size) {
-      aligned_buf = kj::heapArray<capnp::word>(words_size < 512 ? 512 : words_size);
-    }
-    memcpy(aligned_buf.begin(), data, size);
-    return aligned_buf.slice(0, words_size);
-  }
-  inline kj::ArrayPtr<const capnp::word> align(Message *m) {
-    return align(m->getData(), m->getSize());
-  }
-private:
-  kj::Array<capnp::word> aligned_buf;
-  size_t words_size;
-};

cereal/messaging/msgq_to_zmq.cc

@@ -1,146 +0,0 @@
-#include "cereal/messaging/msgq_to_zmq.h"
-
-#include <cassert>
-
-#include "cereal/services.h"
-#include "common/util.h"
-
-extern ExitHandler do_exit;
-
-// Max messages to process per socket per poll
-constexpr int MAX_MESSAGES_PER_SOCKET = 50;
-
-static std::string recv_zmq_msg(void *sock) {
-  zmq_msg_t msg;
-  zmq_msg_init(&msg);
-  std::string ret;
-  if (zmq_msg_recv(&msg, sock, 0) > 0) {
-    ret.assign((char *)zmq_msg_data(&msg), zmq_msg_size(&msg));
-  }
-  zmq_msg_close(&msg);
-  return ret;
-}
-
-void MsgqToZmq::run(const std::vector<std::string> &endpoints, const std::string &ip) {
-  zmq_context = std::make_unique<BridgeZmqContext>();
-  msgq_context = std::make_unique<Context>();
-
-  // Create ZMQPubSockets for each endpoint
-  for (const auto &endpoint : endpoints) {
-    auto &socket_pair = socket_pairs.emplace_back();
-    socket_pair.endpoint = endpoint;
-    socket_pair.pub_sock = std::make_unique<BridgeZmqPubSocket>();
-    int ret = socket_pair.pub_sock->connect(zmq_context.get(), endpoint);
-    if (ret != 0) {
-      printf("Failed to create ZMQ publisher for [%s]: %s\n", endpoint.c_str(), zmq_strerror(zmq_errno()));
-      return;
-    }
-  }
-
-  // Start ZMQ monitoring thread to monitor socket events
-  std::thread thread(&MsgqToZmq::zmqMonitorThread, this);
-
-  // Main loop for processing messages
-  while (!do_exit) {
-    {
-      std::unique_lock lk(mutex);
-      cv.wait(lk, [this]() { return do_exit || !sub2pub.empty(); });
-      if (do_exit) break;
-
-      for (auto sub_sock : msgq_poller->poll(100)) {
-        // Process messages for each socket
-        BridgeZmqPubSocket *pub_sock = sub2pub.at(sub_sock);
-        for (int i = 0; i < MAX_MESSAGES_PER_SOCKET; ++i) {
-          auto msg = std::unique_ptr<Message>(sub_sock->receive(true));
-          if (!msg) break;
-
-          while (pub_sock->sendMessage(msg.get()) == -1) {
-            if (errno != EINTR) break;
-          }
-        }
-      }
-    }
-    util::sleep_for(1);  // Give zmqMonitorThread a chance to acquire the mutex
-  }
-
-  thread.join();
-}
-
-void MsgqToZmq::zmqMonitorThread() {
-  std::vector<zmq_pollitem_t> pollitems;
-
-  // Set up ZMQ monitor for each pub socket
-  for (int i = 0; i < socket_pairs.size(); ++i) {
-    std::string addr = "inproc://op-bridge-monitor-" + std::to_string(i);
-    zmq_socket_monitor(socket_pairs[i].pub_sock->getRawSocket(), addr.c_str(), ZMQ_EVENT_ACCEPTED | ZMQ_EVENT_DISCONNECTED);
-
-    void *monitor_socket = zmq_socket(zmq_context->getRawContext(), ZMQ_PAIR);
-    zmq_connect(monitor_socket, addr.c_str());
-    pollitems.emplace_back(zmq_pollitem_t{.socket = monitor_socket, .events = ZMQ_POLLIN});
-  }
-
-  while (!do_exit) {
-    int ret = zmq_poll(pollitems.data(), pollitems.size(), 1000);
-    if (ret < 0) {
-      if (errno == EINTR) {
-        // Due to frequent EINTR signals from msgq, introduce a brief delay (200 ms)
-        // to reduce CPU usage during retry attempts.
-        util::sleep_for(200);
-      }
-      continue;
-    }
-
-    for (int i = 0; i < pollitems.size(); ++i) {
-      if (pollitems[i].revents & ZMQ_POLLIN) {
-        // First frame in message contains event number and value
-        std::string frame = recv_zmq_msg(pollitems[i].socket);
-        if (frame.empty()) continue;
-
-        uint16_t event_type = *(uint16_t *)(frame.data());
-
-        // Second frame in message contains event address
-        frame = recv_zmq_msg(pollitems[i].socket);
-        if (frame.empty()) continue;
-
-        std::unique_lock lk(mutex);
-        auto &pair = socket_pairs[i];
-        if (event_type & ZMQ_EVENT_ACCEPTED) {
-          printf("socket [%s] connected\n", pair.endpoint.c_str());
-          if (++pair.connected_clients == 1) {
-            // Create new MSGQ subscriber socket and map to ZMQ publisher
-            pair.sub_sock = std::make_unique<MSGQSubSocket>();
-            size_t queue_size = services.at(pair.endpoint).queue_size;
-            pair.sub_sock->connect(msgq_context.get(), pair.endpoint, "127.0.0.1", false, true, queue_size);
-            sub2pub[pair.sub_sock.get()] = pair.pub_sock.get();
-            registerSockets();
-          }
-        } else if (event_type & ZMQ_EVENT_DISCONNECTED) {
-          printf("socket [%s] disconnected\n", pair.endpoint.c_str());
-          if (pair.connected_clients == 0 || --pair.connected_clients == 0) {
-            // Remove MSGQ subscriber socket from mapping and reset it
-            sub2pub.erase(pair.sub_sock.get());
-            pair.sub_sock.reset(nullptr);
-            registerSockets();
-          }
-        }
-        cv.notify_one();
-      }
-    }
-  }
-
-  // Clean up monitor sockets
-  for (int i = 0; i < pollitems.size(); ++i) {
-    zmq_socket_monitor(socket_pairs[i].pub_sock->getRawSocket(), nullptr, 0);
-    zmq_close(pollitems[i].socket);
-  }
-  cv.notify_one();
-}
-
-void MsgqToZmq::registerSockets() {
-  msgq_poller = std::make_unique<MSGQPoller>();
-  for (const auto &socket_pair : socket_pairs) {
-    if (socket_pair.sub_sock) {
-      msgq_poller->registerSocket(socket_pair.sub_sock.get());
-    }
-  }
-}

cereal/messaging/msgq_to_zmq.h

@@ -1,36 +0,0 @@
-#pragma once
-
-#include <condition_variable>
-#include <map>
-#include <memory>
-#include <mutex>
-#include <string>
-#include <vector>
-
-#include "msgq/impl_msgq.h"
-#include "cereal/messaging/bridge_zmq.h"
-
-class MsgqToZmq {
-public:
-  MsgqToZmq() {}
-  void run(const std::vector<std::string> &endpoints, const std::string &ip);
-
-protected:
-  void registerSockets();
-  void zmqMonitorThread();
-
-  struct SocketPair {
-    std::string endpoint;
-    std::unique_ptr<BridgeZmqPubSocket> pub_sock;
-    std::unique_ptr<MSGQSubSocket> sub_sock;
-    int connected_clients = 0;
-  };
-
-  std::unique_ptr<Context> msgq_context;
-  std::unique_ptr<BridgeZmqContext> zmq_context;
-  std::mutex mutex;
-  std::condition_variable cv;
-  std::unique_ptr<MSGQPoller> msgq_poller;
-  std::map<SubSocket *, BridgeZmqPubSocket *> sub2pub;
-  std::vector<SocketPair> socket_pairs;
-};

cereal/messaging/socketmaster.cc

@@ -1,204 +0,0 @@
-#include <assert.h>
-#include <stdlib.h>
-#include <string>
-#include <mutex>
-
-#include "cereal/services.h"
-#include "cereal/messaging/messaging.h"
-
-const bool SIMULATION = (getenv("SIMULATION") != nullptr) && (std::string(getenv("SIMULATION")) == "1");
-
-static inline bool inList(const std::vector<const char *> &list, const char *value) {
-  for (auto &v : list) {
-    if (strcmp(value, v) == 0) return true;
-  }
-  return false;
-}
-
-class MessageContext {
-public:
-  MessageContext() : ctx_(nullptr) {}
-  ~MessageContext() { delete ctx_; }
-  inline Context *context() {
-    std::call_once(init_flag, [=]() { ctx_ = Context::create(); });
-    return ctx_;
-  }
-private:
-  Context *ctx_;
-  std::once_flag init_flag;
-};
-
-MessageContext message_context;
-
-struct SubMaster::SubMessage {
-  std::string name;
-  SubSocket *socket = nullptr;
-  float freq = 0.0f;
-  bool updated = false, alive = false, valid = false, ignore_alive;
-  uint64_t rcv_time = 0, rcv_frame = 0;
-  void *allocated_msg_reader = nullptr;
-  bool is_polled = false;
-  capnp::FlatArrayMessageReader *msg_reader = nullptr;
-  AlignedBuffer aligned_buf;
-  cereal::Event::Reader event;
-};
-
-SubMaster::SubMaster(const std::vector<const char *> &service_list, const std::vector<const char *> &poll,
-                     const char *address, const std::vector<const char *> &ignore_alive) {
-  poller_ = Poller::create();
-  for (auto name : service_list) {
-    assert(services.count(std::string(name)) > 0);
-
-    service serv = services.at(std::string(name));
-    SubSocket *socket = SubSocket::create(message_context.context(), name, address ? address : "127.0.0.1", true, true, serv.queue_size);
-    assert(socket != 0);
-    bool is_polled = inList(poll, name) || poll.empty();
-    if (is_polled) poller_->registerSocket(socket);
-    SubMessage *m = new SubMessage{
-      .name = name,
-      .socket = socket,
-      .freq = serv.frequency,
-      .ignore_alive = inList(ignore_alive, name),
-      .allocated_msg_reader = malloc(sizeof(capnp::FlatArrayMessageReader)),
-      .is_polled = is_polled};
-    m->msg_reader = new (m->allocated_msg_reader) capnp::FlatArrayMessageReader({});
-    messages_[socket] = m;
-    services_[name] = m;
-  }
-}
-
-void SubMaster::update(int timeout) {
-  for (auto &kv : messages_) kv.second->updated = false;
-
-  auto sockets = poller_->poll(timeout);
-
-  // add non-polled sockets for non-blocking receive
-  for (auto &kv : messages_) {
-    SubMessage *m = kv.second;
-    SubSocket *s = kv.first;
-    if (!m->is_polled) sockets.push_back(s);
-  }
-
-  uint64_t current_time = nanos_since_boot();
-
-  std::vector<std::pair<std::string, cereal::Event::Reader>> messages;
-
-  for (auto s : sockets) {
-    Message *msg = s->receive(true);
-    if (msg == nullptr) continue;
-
-    SubMessage *m = messages_.at(s);
-
-    m->msg_reader->~FlatArrayMessageReader();
-    capnp::ReaderOptions options;
-    options.traversalLimitInWords = kj::maxValue; // Don't limit
-    m->msg_reader = new (m->allocated_msg_reader) capnp::FlatArrayMessageReader(m->aligned_buf.align(msg), options);
-    delete msg;
-    messages.push_back({m->name, m->msg_reader->getRoot<cereal::Event>()});
-  }
-
-  update_msgs(current_time, messages);
-}
-
-void SubMaster::update_msgs(uint64_t current_time, const std::vector<std::pair<std::string, cereal::Event::Reader>> &messages){
-  if (++frame == UINT64_MAX) frame = 1;
-
-  for (auto &kv : messages) {
-    auto m_find = services_.find(kv.first);
-    if (m_find == services_.end()){
-      continue;
-    }
-    SubMessage *m = m_find->second;
-    m->event = kv.second;
-    m->updated = true;
-    m->rcv_time = current_time;
-    m->rcv_frame = frame;
-    m->valid = m->event.getValid();
-    if (SIMULATION) m->alive = true;
-  }
-
-  if (!SIMULATION) {
-    for (auto &kv : messages_) {
-      SubMessage *m = kv.second;
-      m->alive = (m->freq <= (1e-5) || ((current_time - m->rcv_time) * (1e-9)) < (10.0 / m->freq));
-    }
-  }
-}
-
-bool SubMaster::all_(const std::vector<const char *> &service_list, bool valid, bool alive) {
-  int found = 0;
-  for (auto &kv : messages_) {
-    SubMessage *m = kv.second;
-    if (service_list.size() == 0 || inList(service_list, m->name.c_str())) {
-      found += (!valid || m->valid) && (!alive || (m->alive || m->ignore_alive));
-    }
-  }
-  return service_list.size() == 0 ? found == messages_.size() : found == service_list.size();
-}
-
-void SubMaster::drain() {
-  while (true) {
-    auto polls = poller_->poll(0);
-    if (polls.size() == 0)
-      break;
-
-    for (auto sock : polls) {
-      Message *msg = sock->receive(true);
-      delete msg;
-    }
-  }
-}
-
-bool SubMaster::updated(const char *name) const {
-  return services_.at(name)->updated;
-}
-
-bool SubMaster::alive(const char *name) const {
-  return services_.at(name)->alive;
-}
-
-bool SubMaster::valid(const char *name) const {
-  return services_.at(name)->valid;
-}
-
-uint64_t SubMaster::rcv_frame(const char *name) const {
-  return services_.at(name)->rcv_frame;
-}
-
-uint64_t SubMaster::rcv_time(const char *name) const {
-  return services_.at(name)->rcv_time;
-}
-
-cereal::Event::Reader &SubMaster::operator[](const char *name) const {
-  return services_.at(name)->event;
-}
-
-SubMaster::~SubMaster() {
-  delete poller_;
-  for (auto &kv : messages_) {
-    SubMessage *m = kv.second;
-    m->msg_reader->~FlatArrayMessageReader();
-    free(m->allocated_msg_reader);
-    delete m->socket;
-    delete m;
-  }
-}
-
-PubMaster::PubMaster(const std::vector<const char *> &service_list) {
-  for (auto name : service_list) {
-    assert(services.count(name) > 0);
-    service serv = services.at(std::string(name));
-    PubSocket *socket = PubSocket::create(message_context.context(), name, true, serv.queue_size);
-    assert(socket);
-    sockets_[name] = socket;
-  }
-}
-
-int PubMaster::send(const char *name, MessageBuilder &msg) {
-  auto bytes = msg.toBytes();
-  return send(name, bytes.begin(), bytes.size());
-}
-
-PubMaster::~PubMaster() {
-  for (auto s : sockets_) delete s.second;
-}

cereal/messaging/tests/test_messaging.py

@@ -1,185 +0,0 @@
-import os
-import capnp
-import multiprocessing
-import numbers
-import random
-import threading
-import time
-from openpilot.common.parameterized import parameterized
-import pytest
-
-from cereal import log, car
-import cereal.messaging as messaging
-from cereal.services import SERVICE_LIST
-
-events = [evt for evt in log.Event.schema.union_fields if evt in SERVICE_LIST.keys()]
-
-def random_sock():
-  return random.choice(events)
-
-def random_socks(num_socks=10):
-  return list({random_sock() for _ in range(num_socks)})
-
-def random_bytes(length=1000):
-  return bytes([random.randrange(0xFF) for _ in range(length)])
-
-def zmq_sleep(t=1):
-  if "ZMQ" in os.environ:
-    time.sleep(t)
-
-
-# TODO: this should take any capnp struct and returrn a msg with random populated data
-def random_carstate():
-  fields = ["vEgo", "aEgo", "brake", "steeringAngleDeg"]
-  msg = messaging.new_message("carState")
-  cs = msg.carState
-  for f in fields:
-    setattr(cs, f, random.random() * 10)
-  return msg
-
-# TODO: this should compare any capnp structs
-def assert_carstate(cs1, cs2):
-  for f in car.CarState.schema.non_union_fields:
-    # TODO: check all types
-    val1, val2 = getattr(cs1, f), getattr(cs2, f)
-    if isinstance(val1, numbers.Number):
-      assert val1 == val2, f"{f}: sent '{val1}' vs recvd '{val2}'"
-
-def delayed_send(delay, sock, dat):
-  def send_func():
-    sock.send(dat)
-  threading.Timer(delay, send_func).start()
-
-
-class TestMessaging:
-  def setUp(self):
-    # TODO: ZMQ tests are too slow; all sleeps will need to be
-    # replaced with logic to block on the necessary condition
-    if "ZMQ" in os.environ:
-      pytest.skip()
-
-    # ZMQ pub socket takes too long to die
-    # sleep to prevent multiple publishers error between tests
-    zmq_sleep()
-
-  @parameterized.expand(events)
-  def test_new_message(self, evt):
-    try:
-      msg = messaging.new_message(evt)
-    except capnp.lib.capnp.KjException:
-      msg = messaging.new_message(evt, random.randrange(200))
-    assert (time.monotonic() - msg.logMonoTime) < 0.1
-    assert not msg.valid
-    assert evt == msg.which()
-
-  @parameterized.expand(events)
-  def test_pub_sock(self, evt):
-    messaging.pub_sock(evt)
-
-  @parameterized.expand(events)
-  def test_sub_sock(self, evt):
-    messaging.sub_sock(evt)
-
-  @parameterized.expand([
-    (messaging.drain_sock, capnp._DynamicStructReader),
-    (messaging.drain_sock_raw, bytes),
-  ])
-  def test_drain_sock(self, func, expected_type):
-    sock = "carState"
-    pub_sock = messaging.pub_sock(sock)
-    sub_sock = messaging.sub_sock(sock, timeout=1000)
-    zmq_sleep()
-
-    # no wait and no msgs in queue
-    msgs = func(sub_sock)
-    assert isinstance(msgs, list)
-    assert len(msgs) == 0
-
-    # no wait but msgs are queued up
-    num_msgs = random.randrange(3, 10)
-    for _ in range(num_msgs):
-      pub_sock.send(messaging.new_message(sock).to_bytes())
-    time.sleep(0.1)
-    msgs = func(sub_sock)
-    assert isinstance(msgs, list)
-    assert all(isinstance(msg, expected_type) for msg in msgs)
-    assert len(msgs) == num_msgs
-
-  def test_recv_sock(self):
-    sock = "carState"
-    pub_sock = messaging.pub_sock(sock)
-    sub_sock = messaging.sub_sock(sock, timeout=100)
-    zmq_sleep()
-
-    # no wait and no msg in queue, socket should timeout
-    recvd = messaging.recv_sock(sub_sock)
-    assert recvd is None
-
-    # no wait and one msg in queue
-    msg = random_carstate()
-    pub_sock.send(msg.to_bytes())
-    time.sleep(0.01)
-    recvd = messaging.recv_sock(sub_sock)
-    assert isinstance(recvd, capnp._DynamicStructReader)
-    # https://github.com/python/mypy/issues/13038
-    assert_carstate(msg.carState, recvd.carState)
-
-  def test_recv_one(self):
-    sock = "carState"
-    pub_sock = messaging.pub_sock(sock)
-    sub_sock = messaging.sub_sock(sock, timeout=1000)
-    zmq_sleep()
-
-    # no msg in queue, socket should timeout
-    recvd = messaging.recv_one(sub_sock)
-    assert recvd is None
-
-    # one msg in queue
-    msg = random_carstate()
-    pub_sock.send(msg.to_bytes())
-    recvd = messaging.recv_one(sub_sock)
-    assert isinstance(recvd, capnp._DynamicStructReader)
-    assert_carstate(msg.carState, recvd.carState)
-
-  @pytest.mark.xfail(condition="ZMQ" in os.environ, reason='ZMQ detected')
-  def test_recv_one_or_none(self):
-    sock = "carState"
-    pub_sock = messaging.pub_sock(sock)
-    sub_sock = messaging.sub_sock(sock)
-    zmq_sleep()
-
-    # no msg in queue, socket shouldn't block
-    recvd = messaging.recv_one_or_none(sub_sock)
-    assert recvd is None
-
-    # one msg in queue
-    msg = random_carstate()
-    pub_sock.send(msg.to_bytes())
-    recvd = messaging.recv_one_or_none(sub_sock)
-    assert isinstance(recvd, capnp._DynamicStructReader)
-    assert_carstate(msg.carState, recvd.carState)
-
-  def test_recv_one_retry(self):
-    sock = "carState"
-    sock_timeout = 0.1
-    pub_sock = messaging.pub_sock(sock)
-    sub_sock = messaging.sub_sock(sock, timeout=round(sock_timeout*1000))
-    zmq_sleep()
-
-    # this test doesn't work with ZMQ since multiprocessing interrupts it
-    if "ZMQ" not in os.environ:
-      # wait 5 socket timeouts and make sure it's still retrying
-      p = multiprocessing.Process(target=messaging.recv_one_retry, args=(sub_sock,))
-      p.start()
-      time.sleep(sock_timeout*5)
-      assert p.is_alive()
-      p.terminate()
-
-    # wait 5 socket timeouts before sending
-    msg = random_carstate()
-    start_time = time.monotonic()
-    delayed_send(sock_timeout*5, pub_sock, msg.to_bytes())
-    recvd = messaging.recv_one_retry(sub_sock)
-    assert (time.monotonic() - start_time) >= sock_timeout*5
-    assert isinstance(recvd, capnp._DynamicStructReader)
-    assert_carstate(msg.carState, recvd.carState)

cereal/messaging/tests/test_pub_sub_master.py

@@ -1,160 +0,0 @@
-import random
-import time
-from typing import Sized, cast
-
-import cereal.messaging as messaging
-from cereal.messaging.tests.test_messaging import events, random_sock, random_socks, \
-                                                  random_bytes, random_carstate, assert_carstate, \
-                                                  zmq_sleep
-from cereal.services import SERVICE_LIST
-
-
-class TestSubMaster:
-
-  def setup_method(self):
-    # ZMQ pub socket takes too long to die
-    # sleep to prevent multiple publishers error between tests
-    zmq_sleep(3)
-
-  def test_init(self):
-    sm = messaging.SubMaster(events)
-    for p in [sm.updated, sm.recv_time, sm.recv_frame, sm.alive,
-              sm.sock, sm.data, sm.logMonoTime, sm.valid]:
-      assert len(cast(Sized, p)) == len(events)
-
-  def test_init_state(self):
-    socks = random_socks()
-    sm = messaging.SubMaster(socks)
-    assert sm.frame == -1
-    assert not any(sm.updated.values())
-    assert not any(sm.seen.values())
-    on_demand = {s: SERVICE_LIST[s].frequency <= 1e-5 for s in sm.services}
-    assert all(sm.alive[s] == sm.valid[s] == sm.freq_ok[s] == on_demand[s] for s in sm.services)
-    assert all(t == 0. for t in sm.recv_time.values())
-    assert all(f == 0 for f in sm.recv_frame.values())
-    assert all(t == 0 for t in sm.logMonoTime.values())
-
-    for p in [sm.updated, sm.recv_time, sm.recv_frame, sm.alive,
-              sm.sock, sm.data, sm.logMonoTime, sm.valid]:
-      assert len(cast(Sized, p)) == len(socks)
-
-  def test_getitem(self):
-    sock = "carState"
-    pub_sock = messaging.pub_sock(sock)
-    sm = messaging.SubMaster([sock,])
-    zmq_sleep()
-
-    msg = random_carstate()
-    pub_sock.send(msg.to_bytes())
-    sm.update(1000)
-    assert_carstate(msg.carState, sm[sock])
-
-  # TODO: break this test up to individually test SubMaster.update and SubMaster.update_msgs
-  def test_update(self):
-    sock = "carState"
-    pub_sock = messaging.pub_sock(sock)
-    sm = messaging.SubMaster([sock,])
-    zmq_sleep()
-
-    for i in range(10):
-      msg = messaging.new_message(sock)
-      pub_sock.send(msg.to_bytes())
-      sm.update(1000)
-      assert sm.frame == i
-      assert all(sm.updated.values())
-
-  def test_update_timeout(self):
-    sock = random_sock()
-    sm = messaging.SubMaster([sock,])
-    timeout = random.randrange(1000, 3000)
-    start_time = time.monotonic()
-    sm.update(timeout)
-    t = time.monotonic() - start_time
-    assert t >= timeout/1000.
-    assert t < 3
-    assert not any(sm.updated.values())
-
-  def test_avg_frequency_checks(self):
-    for poll in (True, False):
-      sm = messaging.SubMaster(["modelV2", "carParams", "carState", "cameraOdometry", "liveCalibration"],
-                               poll=("modelV2" if poll else None),
-                               frequency=(20. if not poll else None))
-
-      checks = {
-        "carState": (20, 20),
-        "modelV2": (20, 20 if poll else 10),
-        "cameraOdometry": (20, 10),
-        "liveCalibration": (4, 4),
-        "carParams": (None, None),
-        "userBookmark": (None, None),
-      }
-
-      for service, (max_freq, min_freq) in checks.items():
-        if max_freq is not None:
-          assert sm._check_avg_freq(service)
-          assert sm.freq_tracker[service].max_freq == max_freq*1.2
-          assert sm.freq_tracker[service].min_freq == min_freq*0.8
-        else:
-          assert not sm._check_avg_freq(service)
-
-  def test_alive(self):
-    pass
-
-  def test_ignore_alive(self):
-    pass
-
-  def test_valid(self):
-    pass
-
-  # SubMaster should always conflate
-  def test_conflate(self):
-    sock = "carState"
-    pub_sock = messaging.pub_sock(sock)
-    sm = messaging.SubMaster([sock,])
-
-    n = 10
-    for i in range(n+1):
-      msg = messaging.new_message(sock)
-      msg.carState.vEgo = i
-      pub_sock.send(msg.to_bytes())
-      time.sleep(0.01)
-    sm.update(1000)
-    assert sm[sock].vEgo == n
-
-
-class TestPubMaster:
-
-  def setup_method(self):
-    # ZMQ pub socket takes too long to die
-    # sleep to prevent multiple publishers error between tests
-    zmq_sleep(3)
-
-  def test_init(self):
-    messaging.PubMaster(events)
-
-  def test_send(self):
-    socks = random_socks()
-    pm = messaging.PubMaster(socks)
-    sub_socks = {s: messaging.sub_sock(s, conflate=True, timeout=1000) for s in socks}
-    zmq_sleep()
-
-    # PubMaster accepts either a capnp msg builder or bytes
-    for capnp in [True, False]:
-      for i in range(100):
-        sock = socks[i % len(socks)]
-
-        if capnp:
-          try:
-            msg = messaging.new_message(sock)
-          except Exception:
-            msg = messaging.new_message(sock, random.randrange(50))
-        else:
-          msg = random_bytes()
-
-        pm.send(sock, msg)
-        recvd = sub_socks[sock].receive()
-
-        if capnp:
-          msg.clear_write_flag()
-          msg = msg.to_bytes()
-        assert msg == recvd, i

cereal/messaging/tests/test_services.py

@@ -1,21 +0,0 @@
-import os
-import tempfile
-from typing import Dict
-from openpilot.common.parameterized import parameterized
-
-import cereal.services as services
-from cereal.services import SERVICE_LIST
-
-
-class TestServices:
-
-  @parameterized.expand(SERVICE_LIST.keys())
-  def test_services(self, s):
-    service = SERVICE_LIST[s]
-    assert service.frequency <= 104
-    assert service.decimation != 0
-
-  def test_generated_header(self):
-    with tempfile.NamedTemporaryFile(suffix=".h") as f:
-      ret = os.system(f"python3 {services.__file__} > {f.name} && clang++ {f.name} -std=c++11")
-      assert ret == 0, "generated services header is not valid C"

cereal/services.py

@@ -1,137 +0,0 @@
-#!/usr/bin/env python3
-from enum import IntEnum
-from typing import Optional
-
-
-# TODO: this should be automatically determined using the capnp schema
-class QueueSize(IntEnum):
-  BIG = 10 * 1024 * 1024      # 10MB - video frames, large AI outputs
-  MEDIUM = 2 * 1024 * 1024    # 2MB - high freq (CAN), livestream
-  SMALL = 250 * 1024          # 250KB - most services
-
-
-class Service:
-  def __init__(self, should_log: bool, frequency: float, decimation: Optional[int] = None,
-               queue_size: QueueSize = QueueSize.SMALL):
-    self.should_log = should_log
-    self.frequency = frequency
-    self.decimation = decimation
-    self.queue_size = queue_size
-
-
-_services: dict[str, tuple] = {
-  # service: (should_log, frequency, qlog decimation (optional))
-  # note: the "EncodeIdx" packets will still be in the log
-  "gyroscope": (True, 104., 104),
-  "accelerometer": (True, 104., 104),
-  "magnetometer": (True, 25.),
-  "lightSensor": (True, 100., 100),
-  "temperatureSensor": (True, 2., 200),
-  "gpsNMEA": (True, 9.),
-  "deviceState": (True, 2., 1),
-  "touch": (True, 20., 1),
-  "can": (True, 100., 2053, QueueSize.BIG),  # decimation gives ~3 msgs in a full segment
-  "controlsState": (True, 100., 10, QueueSize.MEDIUM),
-  "selfdriveState": (True, 100., 10),
-  "pandaStates": (True, 10., 1),
-  "peripheralState": (True, 2., 1),
-  "radarState": (True, 20., 5),
-  "roadEncodeIdx": (False, 20., 1),
-  "liveTracks": (True, 20.),
-  "sendcan": (True, 100., 139, QueueSize.MEDIUM),
-  "logMessage": (True, 0.),
-  "errorLogMessage": (True, 0., 1),
-  "liveCalibration": (True, 4., 4),
-  "liveTorqueParameters": (True, 4., 1),
-  "liveDelay": (True, 4., 1),
-  "androidLog": (True, 0.),
-  "carState": (True, 100., 10),
-  "carControl": (True, 100., 10),
-  "carOutput": (True, 100., 10),
-  "longitudinalPlan": (True, 20., 10),
-  "driverAssistance": (True, 20., 20),
-  "procLog": (True, 0.5, 15, QueueSize.BIG),
-  "gpsLocationExternal": (True, 10., 10),
-  "gpsLocation": (True, 1., 1),
-  "ubloxGnss": (True, 10.),
-  "qcomGnss": (True, 2.),
-  "gnssMeasurements": (True, 10., 10),
-  "clocks": (True, 0.1, 1),
-  "ubloxRaw": (True, 20.),
-  "livePose": (True, 20., 4),
-  "liveParameters": (True, 20., 5),
-  "cameraOdometry": (True, 20., 10),
-  "thumbnail": (True, 1 / 60., 1),
-  "onroadEvents": (True, 1., 1),
-  "carParams": (True, 0.02, 1),
-  "roadCameraState": (True, 20., 20),
-  "driverCameraState": (True, 20., 20),
-  "driverEncodeIdx": (False, 20., 1),
-  "driverStateV2": (True, 20., 10),
-  "driverMonitoringState": (True, 20., 10),
-  "wideRoadEncodeIdx": (False, 20., 1),
-  "wideRoadCameraState": (True, 20., 20),
-  "drivingModelData": (True, 20., 10),
-  "modelV2": (True, 20., None, QueueSize.BIG),
-  "managerState": (True, 2., 1),
-  "uploaderState": (True, 0., 1),
-  "navInstruction": (True, 1., 10),
-  "navRoute": (True, 0.),
-  "navThumbnail": (True, 0.),
-  "qRoadEncodeIdx": (False, 20.),
-  "userBookmark": (True, 0., 1),
-  "soundPressure": (True, 10., 10),
-  "rawAudioData": (False, 20.),
-  "bookmarkButton": (True, 0., 1),
-  "audioFeedback": (True, 0., 1),
-  "roadEncodeData": (False, 20., None, QueueSize.BIG),
-  "driverEncodeData": (False, 20., None, QueueSize.BIG),
-  "wideRoadEncodeData": (False, 20., None, QueueSize.BIG),
-  "qRoadEncodeData": (False, 20., None, QueueSize.BIG),
-
-  # debug
-  "uiDebug": (True, 0., 1),
-  "testJoystick": (True, 0.),
-  "alertDebug": (True, 20., 5),
-  "livestreamWideRoadEncodeIdx": (False, 20.),
-  "livestreamRoadEncodeIdx": (False, 20.),
-  "livestreamDriverEncodeIdx": (False, 20.),
-  "livestreamWideRoadEncodeData": (False, 20., None, QueueSize.MEDIUM),
-  "livestreamRoadEncodeData": (False, 20., None, QueueSize.MEDIUM),
-  "livestreamDriverEncodeData": (False, 20., None, QueueSize.MEDIUM),
-  "customReservedRawData0": (True, 0.),
-  "customReservedRawData1": (True, 0.),
-  "customReservedRawData2": (True, 0.),
-  "controlsStateExt": (True, 100.),
-  "carStateExt": (True, 100.),
-  "modelExt": (True, 20.),
-  "dashyState": (True, 0.),    # Aggregated dashy UI state (optional)
-}
-SERVICE_LIST = {name: Service(*vals) for
-                idx, (name, vals) in enumerate(_services.items())}
-
-
-def build_header():
-  h = ""
-  h += "/* THIS IS AN AUTOGENERATED FILE, PLEASE EDIT services.py */\n"
-  h += "#ifndef __SERVICES_H\n"
-  h += "#define __SERVICES_H\n"
-
-  h += "#include <map>\n"
-  h += "#include <string>\n"
-
-  h += "struct service { std::string name; bool should_log; float frequency; int decimation; size_t queue_size; };\n"
-  h += "static std::map<std::string, service> services = {\n"
-  for k, v in SERVICE_LIST.items():
-    should_log = "true" if v.should_log else "false"
-    decimation = -1 if v.decimation is None else v.decimation
-    h += '  { "%s", {"%s", %s, %f, %d, %d}},\n' % \
-         (k, k, should_log, v.frequency, decimation, v.queue_size)
-  h += "};\n"
-
-  h += "#endif\n"
-  return h
-
-
-if __name__ == "__main__":
-  print(build_header())

check_code_quality.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+pyflakes $(find . -iname "*.py" | grep -vi "^\./pyextra.*" | grep -vi "^\./panda")
+RESULT=$?
+if [ $RESULT -eq 0 ]; then
+    pylint $(find . -iname "*.py" | grep -vi "^\./pyextra.*" | grep -vi "^\./panda")
+    RESULT=$? & 3
+fi
+
+[ $RESULT -ne 0 ] && exit 1
+exit 0

common/SConscript

@@ -1,23 +0,0 @@
-Import('env', 'envCython', 'arch')
-
-common_libs = [
-  'params.cc',
-  'swaglog.cc',
-  'util.cc',
-  'ratekeeper.cc',
-]
-
-_common = env.Library('common', common_libs, LIBS="json11")
-Export('_common')
-
-if GetOption('extras'):
-  env.Program('tests/test_common',
-              ['tests/test_runner.cc', 'tests/test_params.cc', 'tests/test_util.cc', 'tests/test_swaglog.cc'],
-              LIBS=[_common, 'json11', 'zmq', 'pthread'])
-
-# Cython bindings
-params_python = envCython.Program('params_pyx.so', 'params_pyx.pyx', LIBS=envCython['LIBS'] + [_common, 'zmq', 'json11'])
-
-common_python = [params_python]
-
-Export('common_python')

common/api.py

@@ -1,62 +0,0 @@
-import jwt
-import os
-import requests
-from datetime import datetime, timedelta, UTC
-from openpilot.system.hardware.hw import Paths
-from openpilot.system.version import get_version
-
-API_HOST = os.getenv('API_HOST', 'https://api.commadotai.com')
-
-# name: jwt signature algorithm
-KEYS = {"id_rsa": "RS256",
-        "id_ecdsa": "ES256"}
-
-
-class Api:
-  def __init__(self, dongle_id):
-    self.dongle_id = dongle_id
-    self.jwt_algorithm, self.private_key, _ = get_key_pair()
-
-  def get(self, *args, **kwargs):
-    return self.request('GET', *args, **kwargs)
-
-  def post(self, *args, **kwargs):
-    return self.request('POST', *args, **kwargs)
-
-  def request(self, method, endpoint, timeout=None, access_token=None, **params):
-    return api_get(endpoint, method=method, timeout=timeout, access_token=access_token, **params)
-
-  def get_token(self, payload_extra=None, expiry_hours=1):
-    now = datetime.now(UTC).replace(tzinfo=None)
-    payload = {
-      'identity': self.dongle_id,
-      'nbf': now,
-      'iat': now,
-      'exp': now + timedelta(hours=expiry_hours)
-    }
-    if payload_extra is not None:
-      payload.update(payload_extra)
-    token = jwt.encode(payload, self.private_key, algorithm=self.jwt_algorithm)
-    if isinstance(token, bytes):
-      token = token.decode('utf8')
-    return token
-
-
-def api_get(endpoint, method='GET', timeout=None, access_token=None, session=None, **params):
-  headers = {}
-  if access_token is not None:
-    headers['Authorization'] = "JWT " + access_token
-
-  headers['User-Agent'] = "openpilot-" + get_version()
-
-  # TODO: add session to Api
-  req = requests if session is None else session
-  return req.request(method, API_HOST + "/" + endpoint, timeout=timeout, headers=headers, params=params)
-
-
-def get_key_pair() -> tuple[str, str, str] | tuple[None, None, None]:
-  for key in KEYS:
-    if os.path.isfile(Paths.persist_root() + f'/comma/{key}') and os.path.isfile(Paths.persist_root() + f'/comma/{key}.pub'):
-      with open(Paths.persist_root() + f'/comma/{key}') as private, open(Paths.persist_root() + f'/comma/{key}.pub') as public:
-        return KEYS[key], private.read(), public.read()
-  return None, None, None

common/api/__init__.py

@@ -0,0 +1,15 @@
+import requests
+
+from selfdrive.version import version
+
+def api_get(endpoint, method='GET', timeout=None, access_token=None, **params):
+  backend = "https://api.commadotai.com/"
+
+  headers = {}
+  if access_token is not None:
+    headers['Authorization'] = "JWT "+access_token
+
+  headers['User-Agent'] = "openpilot-" + version
+
+  return requests.request(method, backend+endpoint, timeout=timeout, headers = headers, params=params)
+

common/basedir.py

@@ -1,4 +1,4 @@
 import os
-
-
 BASEDIR = os.path.abspath(os.path.join(os.path.dirname(os.path.realpath(__file__)), "../"))
+
+

common/constants.py

@@ -1,23 +0,0 @@
-import numpy as np
-
-# conversions
-class CV:
-  # Speed
-  MPH_TO_KPH = 1.609344
-  KPH_TO_MPH = 1. / MPH_TO_KPH
-  MS_TO_KPH = 3.6
-  KPH_TO_MS = 1. / MS_TO_KPH
-  MS_TO_MPH = MS_TO_KPH * KPH_TO_MPH
-  MPH_TO_MS = MPH_TO_KPH * KPH_TO_MS
-  MS_TO_KNOTS = 1.9438
-  KNOTS_TO_MS = 1. / MS_TO_KNOTS
-
-  # Angle
-  DEG_TO_RAD = np.pi / 180.
-  RAD_TO_DEG = 1. / DEG_TO_RAD
-
-  # Mass
-  LB_TO_KG = 0.453592
-
-
-ACCELERATION_DUE_TO_GRAVITY = 9.81  # m/s^2

common/dbc.py

@@ -0,0 +1,289 @@
+import re
+import os
+import struct
+import sys
+import numbers
+from collections import namedtuple, defaultdict
+
+def int_or_float(s):
+  # return number, trying to maintain int format
+  if s.isdigit():
+    return int(s, 10)
+  else:
+    return float(s)
+
+DBCSignal = namedtuple(
+  "DBCSignal", ["name", "start_bit", "size", "is_little_endian", "is_signed",
+                "factor", "offset", "tmin", "tmax", "units"])
+
+
+class dbc(object):
+  def __init__(self, fn):
+    self.name, _ = os.path.splitext(os.path.basename(fn))
+    with open(fn) as f:
+      self.txt = f.readlines()
+    self._warned_addresses = set()
+
+    # regexps from https://github.com/ebroecker/canmatrix/blob/master/canmatrix/importdbc.py
+    bo_regexp = re.compile(r"^BO\_ (\w+) (\w+) *: (\w+) (\w+)")
+    sg_regexp = re.compile(r"^SG\_ (\w+) : (\d+)\|(\d+)@(\d+)([\+|\-]) \(([0-9.+\-eE]+),([0-9.+\-eE]+)\) \[([0-9.+\-eE]+)\|([0-9.+\-eE]+)\] \"(.*)\" (.*)")
+    sgm_regexp = re.compile(r"^SG\_ (\w+) (\w+) *: (\d+)\|(\d+)@(\d+)([\+|\-]) \(([0-9.+\-eE]+),([0-9.+\-eE]+)\) \[([0-9.+\-eE]+)\|([0-9.+\-eE]+)\] \"(.*)\" (.*)")
+    val_regexp = re.compile(r"VAL\_ (\w+) (\w+) (\s*[-+]?[0-9]+\s+\".+?\"[^;]*)")
+
+    # A dictionary which maps message ids to tuples ((name, size), signals).
+    #   name is the ASCII name of the message.
+    #   size is the size of the message in bytes.
+    #   signals is a list signals contained in the message.
+    # signals is a list of DBCSignal in order of increasing start_bit.
+    self.msgs = {}
+
+    # A dictionary which maps message ids to a list of tuples (signal name, definition value pairs)
+    self.def_vals = defaultdict(list)
+
+    # lookup to bit reverse each byte
+    self.bits_index = [(i & ~0b111) + ((-i-1) & 0b111) for i in xrange(64)]
+
+    for l in self.txt:
+      l = l.strip()
+
+      if l.startswith("BO_ "):
+        # new group
+        dat = bo_regexp.match(l)
+
+        if dat is None:
+          print("bad BO {0}".format(l))
+
+        name = dat.group(2)
+        size = int(dat.group(3))
+        ids = int(dat.group(1), 0) # could be hex
+        if ids in self.msgs:
+          sys.exit("Duplicate address detected %d %s" % (ids, self.name))
+
+        self.msgs[ids] = ((name, size), [])
+
+      if l.startswith("SG_ "):
+        # new signal
+        dat = sg_regexp.match(l)
+        go = 0
+        if dat is None:
+          dat = sgm_regexp.match(l)
+          go = 1
+
+        if dat is None:
+          print("bad SG {0}".format(l))
+
+        sgname = dat.group(1)
+        start_bit = int(dat.group(go+2))
+        signal_size = int(dat.group(go+3))
+        is_little_endian = int(dat.group(go+4))==1
+        is_signed = dat.group(go+5)=='-'
+        factor = int_or_float(dat.group(go+6))
+        offset = int_or_float(dat.group(go+7))
+        tmin = int_or_float(dat.group(go+8))
+        tmax = int_or_float(dat.group(go+9))
+        units = dat.group(go+10)
+
+        self.msgs[ids][1].append(
+          DBCSignal(sgname, start_bit, signal_size, is_little_endian,
+                    is_signed, factor, offset, tmin, tmax, units))
+
+      if l.startswith("VAL_ "):
+        # new signal value/definition
+        dat = val_regexp.match(l)
+
+        if dat is None:
+          print("bad VAL {0}".format(l))
+
+        ids = int(dat.group(1), 0) # could be hex
+        sgname = dat.group(2)
+        defvals = dat.group(3)
+
+        defvals = defvals.replace("?",r"\?") #escape sequence in C++
+        defvals = defvals.split('"')[:-1]
+
+        defs = defvals[1::2]
+        #cleanup, convert to UPPER_CASE_WITH_UNDERSCORES
+        for i,d in enumerate(defs):
+          d = defs[i].strip().upper()
+          defs[i] = d.replace(" ","_")
+
+        defvals[1::2] = defs
+        defvals = '"'+"".join(str(i) for i in defvals)+'"'
+
+        self.def_vals[ids].append((sgname, defvals))
+
+    for msg in self.msgs.values():
+      msg[1].sort(key=lambda x: x.start_bit)
+
+    self.msg_name_to_address = {}
+    for address, m in self.msgs.items():
+      name = m[0][0]
+      self.msg_name_to_address[name] = address
+
+  def lookup_msg_id(self, msg_id):
+    if not isinstance(msg_id, numbers.Number):
+      msg_id = self.msg_name_to_address[msg_id]
+    return msg_id
+
+  def reverse_bytes(self, x):
+    return ((x & 0xff00000000000000) >> 56) | \
+           ((x & 0x00ff000000000000) >> 40) | \
+           ((x & 0x0000ff0000000000) >> 24) | \
+           ((x & 0x000000ff00000000) >> 8) | \
+           ((x & 0x00000000ff000000) << 8) | \
+           ((x & 0x0000000000ff0000) << 24) | \
+           ((x & 0x000000000000ff00) << 40) | \
+           ((x & 0x00000000000000ff) << 56)
+
+  def encode(self, msg_id, dd):
+    """Encode a CAN message using the dbc.
+
+       Inputs:
+        msg_id: The message ID.
+        dd: A dictionary mapping signal name to signal data.
+    """
+    msg_id = self.lookup_msg_id(msg_id)
+
+    msg_def = self.msgs[msg_id]
+    size = msg_def[0][1]
+
+    result = 0
+    for s in msg_def[1]:
+      ival = dd.get(s.name)
+      if ival is not None:
+
+        b2 = s.size
+        if s.is_little_endian:
+          b1 = s.start_bit
+        else:
+          b1 = (s.start_bit // 8) * 8 + (-s.start_bit - 1) % 8
+        bo = 64 - (b1 + s.size)
+
+        ival = (ival / s.factor) - s.offset
+        ival = int(round(ival))
+
+        if s.is_signed and ival < 0:
+          ival = (1 << b2) + ival
+
+        shift = b1 if s.is_little_endian else bo
+        mask = ((1 << b2) - 1) << shift
+        dat = (ival & ((1 << b2) - 1)) << shift
+
+        if s.is_little_endian:
+          mask = self.reverse_bytes(mask)
+          dat = self.reverse_bytes(dat)
+
+        result &= ~mask
+        result |= dat
+
+    result = struct.pack('>Q', result)
+    return result[:size]
+
+  def decode(self, x, arr=None, debug=False):
+    """Decode a CAN message using the dbc.
+
+       Inputs:
+        x: A collection with elements (address, time, data), where address is
+           the CAN address, time is the bus time, and data is the CAN data as a
+           hex string.
+        arr: Optional list of signals which should be decoded and returned.
+        debug: True to print debugging statements.
+
+       Returns:
+        A tuple (name, data), where name is the name of the CAN message and data
+        is the decoded result. If arr is None, data is a dict of properties.
+        Otherwise data is a list of the same length as arr.
+
+        Returns (None, None) if the message could not be decoded.
+    """
+
+    if arr is None:
+      out = {}
+    else:
+      out = [None]*len(arr)
+
+    msg = self.msgs.get(x[0])
+    if msg is None:
+      if x[0] not in self._warned_addresses:
+        #print("WARNING: Unknown message address {}".format(x[0]))
+        self._warned_addresses.add(x[0])
+      return None, None
+
+    name = msg[0][0]
+    if debug:
+      print(name)
+
+    st = x[2].ljust(8, '\x00')
+    le, be = None, None
+
+    for s in msg[1]:
+      if arr is not None and s[0] not in arr:
+        continue
+
+      start_bit = s[1]
+      signal_size = s[2]
+      little_endian = s[3]
+      signed = s[4]
+      factor = s[5]
+      offset = s[6]
+
+      b2 = signal_size
+      if little_endian:
+        b1 = start_bit
+      else:
+        b1 = (start_bit // 8) * 8 + (-start_bit - 1) % 8
+      bo = 64 - (b1 + signal_size)
+
+      if little_endian:
+        if le is None:
+          le = struct.unpack("<Q", st)[0]
+        shift_amount = b1
+        tmp = le
+      else:
+        if be is None:
+          be = struct.unpack(">Q", st)[0]
+        shift_amount = bo
+        tmp = be
+
+      if shift_amount < 0:
+        continue
+
+      tmp = (tmp >> shift_amount) & ((1 << b2) - 1)
+      if signed and (tmp >> (b2 - 1)):
+        tmp -= (1 << b2)
+
+      tmp = tmp * factor + offset
+
+      # if debug:
+      #   print("%40s  %2d %2d  %7.2f %s" % (s[0], s[1], s[2], tmp, s[-1]))
+
+      if arr is None:
+        out[s[0]] = tmp
+      else:
+        out[arr.index(s[0])] = tmp
+    return name, out
+
+  def get_signals(self, msg):
+    msg = self.lookup_msg_id(msg)
+    return [sgs.name for sgs in self.msgs[msg][1]]
+
+
+if __name__ == "__main__":
+   from opendbc import DBC_PATH
+   import numpy as np
+
+   dbc_test = dbc(os.path.join(DBC_PATH, 'toyota_prius_2017_pt_generated.dbc'))
+   msg = ('STEER_ANGLE_SENSOR', {'STEER_ANGLE': -6.0, 'STEER_RATE': 4, 'STEER_FRACTION': -0.2})
+   encoded = dbc_test.encode(*msg)
+   decoded = dbc_test.decode((0x25, 0, encoded))
+   assert decoded == msg
+
+   dbc_test = dbc(os.path.join(DBC_PATH, 'hyundai_santa_fe_2019_ccan.dbc'))
+   decoded = dbc_test.decode((0x2b0, 0, "\xfa\xfe\x00\x07\x12"))
+   assert np.isclose(decoded[1]['SAS_Angle'], -26.2)
+
+   msg = ('SAS11', {'SAS_Stat': 7.0, 'MsgCount': 0.0, 'SAS_Angle': -26.200000000000003, 'SAS_Speed': 0.0, 'CheckSum': 0.0})
+   encoded = dbc_test.encode(*msg)
+   decoded = dbc_test.decode((0x2b0, 0, encoded))
+
+   assert decoded == msg

common/ffi_wrapper.py

@@ -0,0 +1,49 @@
+import os
+import sys
+import fcntl
+import hashlib
+from cffi import FFI
+
+
+def ffi_wrap(name, c_code, c_header, tmpdir="/tmp/ccache", cflags="", libraries=None):
+  if libraries is None:
+    libraries = []
+
+  cache = name + "_" + hashlib.sha1(c_code).hexdigest()
+  try:
+    os.mkdir(tmpdir)
+  except OSError:
+    pass
+
+  fd = os.open(tmpdir, 0)
+  fcntl.flock(fd, fcntl.LOCK_EX)
+  try:
+    sys.path.append(tmpdir)
+    try:
+      mod = __import__(cache)
+    except Exception:
+      print("cache miss {0}".format(cache))
+      compile_code(cache, c_code, c_header, tmpdir, cflags, libraries)
+      mod = __import__(cache)
+  finally:
+    os.close(fd)
+
+  return mod.ffi, mod.lib
+
+
+def compile_code(name, c_code, c_header, directory, cflags="", libraries=None):
+  if libraries is None:
+    libraries = []
+
+  ffibuilder = FFI()
+  ffibuilder.set_source(name, c_code, source_extension='.cpp', libraries=libraries)
+  ffibuilder.cdef(c_header)
+  os.environ['OPT'] = "-fwrapv -O2 -DNDEBUG -std=c++11"
+  os.environ['CFLAGS'] = cflags
+  ffibuilder.compile(verbose=True, debug=False, tmpdir=directory)
+
+
+def wrap_compiled(name, directory):
+  sys.path.append(directory)
+  mod = __import__(name)
+  return mod.ffi, mod.lib

common/file_chunker.py

@@ -1,37 +0,0 @@
-import math
-import os
-from pathlib import Path
-
-CHUNK_SIZE = 45 * 1024 * 1024  # 45MB, under GitHub's 50MB limit
-
-def get_chunk_name(name, idx, num_chunks):
-  return f"{name}.chunk{idx+1:02d}of{num_chunks:02d}"
-
-def get_manifest_path(name):
-  return f"{name}.chunkmanifest"
-
-def get_chunk_paths(path, file_size):
-  num_chunks = math.ceil(file_size / CHUNK_SIZE)
-  return [get_manifest_path(path)] + [get_chunk_name(path, i, num_chunks) for i in range(num_chunks)]
-
-def chunk_file(path, targets):
-  manifest_path, *chunk_paths = targets
-  with open(path, 'rb') as f:
-    data = f.read()
-  actual_num_chunks = max(1, math.ceil(len(data) / CHUNK_SIZE))
-  assert len(chunk_paths) >= actual_num_chunks, f"Allowed {len(chunk_paths)} chunks but needs at least {actual_num_chunks}, for path {path}"
-  for i, chunk_path in enumerate(chunk_paths):
-    with open(chunk_path, 'wb') as f:
-      f.write(data[i * CHUNK_SIZE:(i + 1) * CHUNK_SIZE])
-  Path(manifest_path).write_text(str(len(chunk_paths)))
-  os.remove(path)
-
-
-def read_file_chunked(path):
-  manifest_path = get_manifest_path(path)
-  if os.path.isfile(manifest_path):
-    num_chunks = int(Path(manifest_path).read_text().strip())
-    return b''.join(Path(get_chunk_name(path, i, num_chunks)).read_bytes() for i in range(num_chunks))
-  if os.path.isfile(path):
-    return Path(path).read_bytes()
-  raise FileNotFoundError(path)

common/filter_simple.py

@@ -1,34 +1,10 @@
-class FirstOrderFilter:
-  def __init__(self, x0, rc, dt, initialized=True):
+class FirstOrderFilter():
+  # first order filter
+  def __init__(self, x0, ts, dt):
+    self.k = (dt / ts) / (1. + dt / ts)
     self.x = x0
-    self.dt = dt
-    self.update_alpha(rc)
-    self.initialized = initialized
-
-  def update_alpha(self, rc):
-    self.alpha = self.dt / (rc + self.dt)
 
   def update(self, x):
-    if self.initialized:
-      self.x = (1. - self.alpha) * self.x + self.alpha * x
-    else:
-      self.initialized = True
-      self.x = x
-    return self.x
+    self.x = (1. - self.k) * self.x + self.k * x
 
 
-class BounceFilter(FirstOrderFilter):
-  def __init__(self, x0, rc, dt, initialized=True, bounce=2):
-    self.velocity = FirstOrderFilter(0.0, 0.15, dt)
-    self.bounce = bounce
-    super().__init__(x0, rc, dt, initialized)
-
-  def update(self, x):
-    super().update(x)
-    scale = self.dt / (1.0 / 60.0)  # tuned at 60 fps
-    self.velocity.x += (x - self.x) * self.bounce * scale * self.dt
-    self.velocity.update(0.0)
-    if abs(self.velocity.x) < 1e-3:
-      self.velocity.x = 0.0
-    self.x += self.velocity.x
-    return self.x

common/fingerprints.py

@@ -0,0 +1,64 @@
+import os
+from common.basedir import BASEDIR
+
+def get_fingerprint_list():
+  # read all the folders in selfdrive/car and return a dict where:
+  # - keys are all the car models for which we have a fingerprint
+  # - values are lists dicts of messages that constitute the unique 
+  #   CAN fingerprint of each car model and all its variants
+  fingerprints = {}
+  for car_folder in [x[0] for x in os.walk(BASEDIR + '/selfdrive/car')]:
+    try:
+      car_name = car_folder.split('/')[-1]
+      values = __import__('selfdrive.car.%s.values' % car_name, fromlist=['FINGERPRINTS'])
+      if hasattr(values, 'FINGERPRINTS'):
+        car_fingerprints = values.FINGERPRINTS
+      else:
+        continue
+      for f, v in car_fingerprints.items():
+        fingerprints[f] = v
+    except (ImportError, IOError):
+      pass
+  return fingerprints
+
+
+_FINGERPRINTS = get_fingerprint_list()
+
+_DEBUG_ADDRESS = {1880: 8}   # reserved for debug purposes
+
+def is_valid_for_fingerprint(msg, car_fingerprint):
+  adr = msg.address
+  bus = msg.src
+  # ignore addresses that are more than 11 bits
+  return (adr in car_fingerprint and car_fingerprint[adr] == len(msg.dat)) or \
+         bus != 0 or adr >= 0x800
+
+
+def eliminate_incompatible_cars(msg, candidate_cars):
+  """Removes cars that could not have sent msg.
+
+     Inputs:
+      msg: A cereal/log CanData message from the car.
+      candidate_cars: A list of cars to consider.
+
+     Returns:
+      A list containing the subset of candidate_cars that could have sent msg.
+  """
+  compatible_cars = []
+
+  for car_name in candidate_cars:
+    car_fingerprints = _FINGERPRINTS[car_name]
+
+    for fingerprint in car_fingerprints:
+      fingerprint.update(_DEBUG_ADDRESS)  # add alien debug address
+
+      if is_valid_for_fingerprint(msg, fingerprint):
+        compatible_cars.append(car_name)
+        break
+
+  return compatible_cars
+
+
+def all_known_cars():
+  """Returns a list of all known car strings."""
+  return list(_FINGERPRINTS.keys())

common/git.py

@@ -1,42 +0,0 @@
-from functools import cache
-import subprocess
-from openpilot.common.utils import run_cmd, run_cmd_default
-
-
-@cache
-def get_commit(cwd: str | None = None, branch: str = "HEAD") -> str:
-  return run_cmd_default(["git", "rev-parse", branch], cwd=cwd)
-
-
-@cache
-def get_commit_date(cwd: str | None = None, commit: str = "HEAD") -> str:
-  return run_cmd_default(["git", "show", "--no-patch", "--format='%ct %ci'", commit], cwd=cwd)
-
-
-@cache
-def get_short_branch(cwd: str | None = None) -> str:
-  return run_cmd_default(["git", "rev-parse", "--abbrev-ref", "HEAD"], cwd=cwd)
-
-
-@cache
-def get_branch(cwd: str | None = None) -> str:
-  return run_cmd_default(["git", "rev-parse", "--abbrev-ref", "--symbolic-full-name", "@{u}"], cwd=cwd)
-
-
-@cache
-def get_origin(cwd: str | None = None) -> str:
-  try:
-    local_branch = run_cmd(["git", "name-rev", "--name-only", "HEAD"], cwd=cwd)
-    tracking_remote = run_cmd(["git", "config", "branch." + local_branch + ".remote"], cwd=cwd)
-    return run_cmd(["git", "config", "remote." + tracking_remote + ".url"], cwd=cwd)
-  except subprocess.CalledProcessError:  # Not on a branch, fallback
-    return run_cmd_default(["git", "config", "--get", "remote.origin.url"], cwd=cwd)
-
-
-@cache
-def get_normalized_origin(cwd: str | None = None) -> str:
-  return get_origin(cwd) \
-    .replace("git@", "", 1) \
-    .replace(".git", "", 1) \
-    .replace("https://", "", 1) \
-    .replace(":", "/", 1)

common/gpio.py

@@ -1,89 +0,0 @@
-import os
-import fcntl
-import ctypes
-from functools import cache
-
-def gpio_init(pin: int, output: bool) -> None:
-  try:
-    with open(f"/sys/class/gpio/gpio{pin}/direction", 'wb') as f:
-      f.write(b"out" if output else b"in")
-  except Exception as e:
-    print(f"Failed to set gpio {pin} direction: {e}")
-
-def gpio_set(pin: int, high: bool) -> None:
-  try:
-    with open(f"/sys/class/gpio/gpio{pin}/value", 'wb') as f:
-      f.write(b"1" if high else b"0")
-  except Exception as e:
-    print(f"Failed to set gpio {pin} value: {e}")
-
-def gpio_read(pin: int) -> bool | None:
-  val = None
-  try:
-    with open(f"/sys/class/gpio/gpio{pin}/value", 'rb') as f:
-      val = bool(int(f.read().strip()))
-  except Exception as e:
-    print(f"Failed to set gpio {pin} value: {e}")
-
-  return val
-
-def gpio_export(pin: int) -> None:
-  if os.path.isdir(f"/sys/class/gpio/gpio{pin}"):
-    return
-
-  try:
-    with open("/sys/class/gpio/export", 'w') as f:
-      f.write(str(pin))
-  except Exception:
-    print(f"Failed to export gpio {pin}")
-
-@cache
-def get_irq_action(irq: int) -> list[str]:
-  try:
-    with open(f"/sys/kernel/irq/{irq}/actions") as f:
-      actions = f.read().strip().split(',')
-      return actions
-  except FileNotFoundError:
-    return []
-
-def get_irqs_for_action(action: str) -> list[str]:
-  ret = []
-  with open("/proc/interrupts") as f:
-    for l in f.readlines():
-      irq = l.split(':')[0].strip()
-      if irq.isdigit() and action in get_irq_action(irq):
-        ret.append(irq)
-  return ret
-
-# *** gpiochip ***
-
-class gpioevent_data(ctypes.Structure):
-  _fields_ = [
-    ("timestamp", ctypes.c_uint64),
-    ("id", ctypes.c_uint32),
-  ]
-
-class gpioevent_request(ctypes.Structure):
-  _fields_ = [
-    ("lineoffset", ctypes.c_uint32),
-    ("handleflags", ctypes.c_uint32),
-    ("eventflags", ctypes.c_uint32),
-    ("label", ctypes.c_char * 32),
-    ("fd", ctypes.c_int)
-  ]
-
-def gpiochip_get_ro_value_fd(label: str, gpiochip_id: int, pin: int) -> int:
-  GPIOEVENT_REQUEST_BOTH_EDGES = 0x3
-  GPIOHANDLE_REQUEST_INPUT = 0x1
-  GPIO_GET_LINEEVENT_IOCTL = 0xc030b404
-
-  rq = gpioevent_request()
-  rq.lineoffset = pin
-  rq.handleflags = GPIOHANDLE_REQUEST_INPUT
-  rq.eventflags = GPIOEVENT_REQUEST_BOTH_EDGES
-  rq.label = label.encode('utf-8')[:31] + b'\0'
-
-  fd = os.open(f"/dev/gpiochip{gpiochip_id}", os.O_RDONLY)
-  fcntl.ioctl(fd, GPIO_GET_LINEEVENT_IOCTL, rq)
-  os.close(fd)
-  return int(rq.fd)

common/gps.py

@@ -1,8 +0,0 @@
-from openpilot.common.params import Params
-
-
-def get_gps_location_service(params: Params) -> str:
-  if params.get_bool("UbloxAvailable"):
-    return "gpsLocationExternal"
-  else:
-    return "gpsLocation"

common/i2c.py

@@ -1,81 +0,0 @@
-import os
-import fcntl
-import ctypes
-
-# I2C constants from /usr/include/linux/i2c-dev.h
-I2C_SLAVE = 0x0703
-I2C_SLAVE_FORCE = 0x0706
-I2C_SMBUS = 0x0720
-
-# SMBus transfer types
-I2C_SMBUS_READ = 1
-I2C_SMBUS_WRITE = 0
-I2C_SMBUS_BYTE_DATA = 2
-I2C_SMBUS_I2C_BLOCK_DATA = 8
-
-I2C_SMBUS_BLOCK_MAX = 32
-
-
-class _I2cSmbusData(ctypes.Union):
-  _fields_ = [
-    ("byte", ctypes.c_uint8),
-    ("word", ctypes.c_uint16),
-    ("block", ctypes.c_uint8 * (I2C_SMBUS_BLOCK_MAX + 2)),
-  ]
-
-
-class _I2cSmbusIoctlData(ctypes.Structure):
-  _fields_ = [
-    ("read_write", ctypes.c_uint8),
-    ("command", ctypes.c_uint8),
-    ("size", ctypes.c_uint32),
-    ("data", ctypes.POINTER(_I2cSmbusData)),
-  ]
-
-
-class SMBus:
-  def __init__(self, bus: int):
-    self._fd = os.open(f'/dev/i2c-{bus}', os.O_RDWR)
-
-  def __enter__(self) -> 'SMBus':
-    return self
-
-  def __exit__(self, *args) -> None:
-    self.close()
-
-  def close(self) -> None:
-    if hasattr(self, '_fd') and self._fd >= 0:
-      os.close(self._fd)
-      self._fd = -1
-
-  def _set_address(self, addr: int, force: bool = False) -> None:
-    ioctl_arg = I2C_SLAVE_FORCE if force else I2C_SLAVE
-    fcntl.ioctl(self._fd, ioctl_arg, addr)
-
-  def _smbus_access(self, read_write: int, command: int, size: int, data: _I2cSmbusData) -> None:
-    ioctl_data = _I2cSmbusIoctlData(read_write, command, size, ctypes.pointer(data))
-    fcntl.ioctl(self._fd, I2C_SMBUS, ioctl_data)
-
-  def read_byte_data(self, addr: int, register: int, force: bool = False) -> int:
-    self._set_address(addr, force)
-    data = _I2cSmbusData()
-    self._smbus_access(I2C_SMBUS_READ, register, I2C_SMBUS_BYTE_DATA, data)
-    return int(data.byte)
-
-  def write_byte_data(self, addr: int, register: int, value: int, force: bool = False) -> None:
-    self._set_address(addr, force)
-    data = _I2cSmbusData()
-    data.byte = value & 0xFF
-    self._smbus_access(I2C_SMBUS_WRITE, register, I2C_SMBUS_BYTE_DATA, data)
-
-  def read_i2c_block_data(self, addr: int, register: int, length: int, force: bool = False) -> list[int]:
-    self._set_address(addr, force)
-    if not (0 <= length <= I2C_SMBUS_BLOCK_MAX):
-      raise ValueError(f"length must be 0..{I2C_SMBUS_BLOCK_MAX}")
-
-    data = _I2cSmbusData()
-    data.block[0] = length
-    self._smbus_access(I2C_SMBUS_READ, register, I2C_SMBUS_I2C_BLOCK_DATA, data)
-    read_len = int(data.block[0]) or length
-    read_len = min(read_len, length)
-    return [int(b) for b in data.block[1 : read_len + 1]]

common/kalman/Makefile

@@ -0,0 +1,10 @@
+all: simple_kalman_impl.so
+
+simple_kalman_impl.so: simple_kalman_impl.pyx simple_kalman_impl.pxd simple_kalman_setup.py
+	python simple_kalman_setup.py build_ext --inplace
+	rm -rf build
+	rm simple_kalman_impl.c
+
+.PHONY: clean
+clean:
+	rm -f simple_kalman_impl.so

common/kalman/ekf.py

@@ -0,0 +1,253 @@
+# pylint: skip-file
+from __future__ import print_function
+import abc
+import numpy as np
+# The EKF class contains the framework for an Extended Kalman Filter, but must be subclassed to use.
+# A subclass must implement:
+#   1) calc_transfer_fun(); see bottom of file for more info.
+#   2) __init__() to initialize self.state, self.covar, and self.process_noise appropriately
+
+# Alternatively, the existing implementations of EKF can be used (e.g. EKF2D)
+
+# Sensor classes are optionally used to pass measurement information into the EKF, to keep
+#   sensor parameters and processing methods for a each sensor together.
+# Sensor classes have a read() method which takes raw sensor data and returns
+#   a SensorReading object, which can be passed to the EKF update() method.
+
+# For usage, see run_ekf1d.py in selfdrive/new for a simple example.
+# ekf.predict(dt) should be called between update cycles with the time since it was last called.
+# Ideally, predict(dt) should be called at a relatively constant rate.
+# update() should be called once per sensor, and can be called multiple times between predict steps.
+# Access and set the state of the filter directly with ekf.state and ekf.covar.
+
+
+class SensorReading:
+  # Given a perfect model and no noise, data = obs_model * state
+  def __init__(self, data, covar, obs_model):
+    self.data = data
+    self.obs_model = obs_model
+    self.covar = covar
+
+  def __repr__(self):
+    return "SensorReading(data={}, covar={}, obs_model={})".format(
+      repr(self.data), repr(self.covar), repr(self.obs_model))
+
+
+# A generic sensor class that does no pre-processing of data
+class SimpleSensor:
+  # obs_model can be
+  #   a full observation model matrix, or
+  #   an integer or tuple of indices into ekf.state, indicating which variables are being directly observed
+  # covar can be
+  #   a full covariance matrix
+  #   a float or tuple of individual covars for each component of the sensor reading
+  # dims is the number of states in the EKF
+  def __init__(self, obs_model, covar, dims):
+    # Allow for integer covar/obs_model
+    if not hasattr(obs_model, "__len__"):
+      obs_model = (obs_model, )
+    if not hasattr(covar, "__len__"):
+      covar = (covar, )
+
+    # Full observation model passed
+    if dims in np.array(obs_model).shape:
+      self.obs_model = np.asmatrix(obs_model)
+      self.covar = np.asmatrix(covar)
+    # Indices of unit observations passed
+    else:
+      self.obs_model = np.matlib.zeros((len(obs_model), dims))
+      self.obs_model[:, list(obs_model)] = np.identity(len(obs_model))
+      if np.asarray(covar).ndim == 2:
+        self.covar = np.asmatrix(covar)
+      elif len(covar) == len(obs_model):
+        self.covar = np.matlib.diag(covar)
+      else:
+        self.covar = np.matlib.identity(len(obs_model)) * covar
+
+  def read(self, data, covar=None):
+    if covar:
+      self.covar = covar
+    return SensorReading(data, self.covar, self.obs_model)
+
+
+class EKF:
+  __metaclass__ = abc.ABCMeta
+
+  def __init__(self, debug=False):
+    self.DEBUG = debug
+
+
+  def __str__(self):
+    return "EKF(state={}, covar={})".format(self.state, self.covar)
+
+  # Measurement update
+  # Reading should be a SensorReading object with data, covar, and obs_model attributes
+  def update(self, reading):
+    # Potential improvements:
+    # deal with negative covars
+    # add noise to really low covars to ensure stability
+    # use mahalanobis distance to reject outliers
+    # wrap angles after state updates and innovation
+
+    # y = z - H*x
+    innovation = reading.data - reading.obs_model * self.state
+
+    if self.DEBUG:
+      print("reading:\n",reading.data)
+      print("innovation:\n",innovation)
+
+    # S = H*P*H' + R
+    innovation_covar = reading.obs_model * self.covar * reading.obs_model.T + reading.covar
+
+    # K = P*H'*S^-1
+    kalman_gain = self.covar * reading.obs_model.T * np.linalg.inv(
+      innovation_covar)
+
+    if self.DEBUG:
+      print("gain:\n", kalman_gain)
+      print("innovation_covar:\n", innovation_covar)
+      print("innovation: ", innovation)
+      print("test: ", self.covar * reading.obs_model.T * (
+        reading.obs_model * self.covar * reading.obs_model.T + reading.covar *
+        0).I)
+
+    # x = x + K*y
+    self.state += kalman_gain*innovation
+
+    # print "covar", np.diag(self.covar)
+    #self.state[(roll_vel, yaw_vel, pitch_vel),:] = reading.data
+
+    # Standard form: P = (I - K*H)*P
+    # self.covar = (self.identity - kalman_gain*reading.obs_model) * self.covar
+
+    # Use the Joseph form for numerical stability: P = (I-K*H)*P*(I - K*H)' + K*R*K'
+    aux_mtrx = (self.identity - kalman_gain * reading.obs_model)
+    self.covar = aux_mtrx * self.covar * aux_mtrx.T + kalman_gain * reading.covar * kalman_gain.T
+
+    if self.DEBUG:
+      print("After update")
+      print("state\n", self.state)
+      print("covar:\n",self.covar)
+
+  def update_scalar(self, reading):
+    # like update but knowing that measurement is a scalar
+    # this avoids matrix inversions and speeds up (surprisingly) drived.py a lot
+
+    # innovation = reading.data - np.matmul(reading.obs_model, self.state)
+    # innovation_covar = np.matmul(np.matmul(reading.obs_model, self.covar), reading.obs_model.T) + reading.covar
+    # kalman_gain = np.matmul(self.covar, reading.obs_model.T)/innovation_covar
+    # self.state += np.matmul(kalman_gain, innovation)
+    # aux_mtrx = self.identity - np.matmul(kalman_gain, reading.obs_model)
+    # self.covar =  np.matmul(aux_mtrx, np.matmul(self.covar, aux_mtrx.T)) + np.matmul(kalman_gain, np.matmul(reading.covar, kalman_gain.T))
+
+    # written without np.matmul
+    es = np.einsum
+    ABC_T = "ij,jk,lk->il"
+    AB_T = "ij,kj->ik"
+    AB = "ij,jk->ik"
+    innovation = reading.data - es(AB, reading.obs_model, self.state)
+    innovation_covar = es(ABC_T, reading.obs_model, self.covar,
+                          reading.obs_model) + reading.covar
+    kalman_gain = es(AB_T, self.covar, reading.obs_model) / innovation_covar
+
+    self.state += es(AB, kalman_gain, innovation)
+    aux_mtrx = self.identity - es(AB, kalman_gain, reading.obs_model)
+    self.covar = es(ABC_T, aux_mtrx, self.covar, aux_mtrx) + \
+                 es(ABC_T, kalman_gain, reading.covar, kalman_gain)
+
+  # Prediction update
+  def predict(self, dt):
+    es = np.einsum
+    ABC_T = "ij,jk,lk->il"
+    AB = "ij,jk->ik"
+
+    # State update
+    transfer_fun, transfer_fun_jacobian = self.calc_transfer_fun(dt)
+
+    # self.state = np.matmul(transfer_fun, self.state)
+    # self.covar = np.matmul(np.matmul(transfer_fun_jacobian, self.covar), transfer_fun_jacobian.T) + self.process_noise * dt
+
+    # x = f(x, u), written in the form x = A(x, u)*x
+    self.state = es(AB, transfer_fun, self.state)
+
+    # P = J*P*J' + Q
+    self.covar = es(ABC_T, transfer_fun_jacobian, self.covar,
+                    transfer_fun_jacobian) + self.process_noise * dt  #!dt
+
+    #! Clip covariance to avoid explosions
+    self.covar = np.clip(self.covar,-1e10,1e10)
+
+  @abc.abstractmethod
+  def calc_transfer_fun(self, dt):
+    """Return a tuple with the transfer function and transfer function jacobian
+    The transfer function and jacobian should both be a numpy matrix of size DIMSxDIMS
+
+    The transfer function matrix A should satisfy the state-update equation
+      x_(k+1) = A * x_k
+
+    The jacobian J is the direct jacobian A*x_k. For linear systems J=A.
+
+    Current implementations calculate A and J as functions of state. Control input
+      can be added trivially by adding a control parameter to predict() and calc_tranfer_update(),
+      and using it during calculation of A and J
+    """
+
+
+class FastEKF1D(EKF):
+  """Fast version of EKF for 1D problems with scalar readings."""
+
+  def __init__(self, dt, var_init, Q):
+    super(FastEKF1D, self).__init__(False)
+    self.state = [0, 0]
+    self.covar = [var_init, var_init, 0]
+
+    # Process Noise
+    self.dtQ0 = dt * Q[0]
+    self.dtQ1 = dt * Q[1]
+
+  def update(self, reading):
+    raise NotImplementedError
+
+  def update_scalar(self, reading):
+    # TODO(mgraczyk): Delete this for speed.
+    # assert np.all(reading.obs_model == [1, 0])
+
+    rcov = reading.covar[0, 0]
+
+    x = self.state
+    S = self.covar
+
+    innovation = reading.data - x[0]
+    innovation_covar = S[0] + rcov
+
+    k0 = S[0] / innovation_covar
+    k1 = S[2] / innovation_covar
+
+    x[0] += k0 * innovation
+    x[1] += k1 * innovation
+
+    mk = 1 - k0
+    S[1] += k1 * (k1 * (S[0] + rcov) - 2 * S[2])
+    S[2] = mk * (S[2] - k1 * S[0]) + rcov * k0 * k1
+    S[0] = mk * mk * S[0] + rcov * k0 * k0
+
+  def predict(self, dt):
+    # State update
+    x = self.state
+
+    x[0] += dt * x[1]
+
+    # P = J*P*J' + Q
+    S = self.covar
+    S[0] += dt * (2 * S[2] + dt * S[1]) + self.dtQ0
+    S[2] += dt * S[1]
+    S[1] += self.dtQ1
+
+    # Clip covariance to avoid explosions
+    S = max(-1e10, min(S, 1e10))
+
+  def calc_transfer_fun(self, dt):
+    tf = np.identity(2)
+    tf[0, 1] = dt
+    tfj = tf
+    return tf, tfj

common/kalman/simple_kalman.py

@@ -0,0 +1,10 @@
+# pylint: skip-file
+import os
+import subprocess
+
+kalman_dir = os.path.dirname(os.path.abspath(__file__))
+subprocess.check_call(["make", "simple_kalman_impl.so"], cwd=kalman_dir)
+
+from simple_kalman_impl import KF1D as KF1D
+# Silence pyflakes
+assert KF1D

common/kalman/simple_kalman_impl.pxd

@@ -0,0 +1,16 @@
+cdef class KF1D:
+  cdef public:
+    double x0_0
+    double x1_0
+    double K0_0
+    double K1_0
+    double A0_0
+    double A0_1
+    double A1_0
+    double A1_1
+    double C0_0
+    double C0_1
+    double A_K_0
+    double A_K_1
+    double A_K_2
+    double A_K_3

common/kalman/simple_kalman_impl.pyx

@@ -0,0 +1,35 @@
+
+cdef class KF1D:
+  def __init__(self, x0, A, C, K):
+    self.x0_0 = x0[0][0]
+    self.x1_0 = x0[1][0]
+    self.A0_0 = A[0][0]
+    self.A0_1 = A[0][1]
+    self.A1_0 = A[1][0]
+    self.A1_1 = A[1][1]
+    self.C0_0 = C[0]
+    self.C0_1 = C[1]
+    self.K0_0 = K[0][0]
+    self.K1_0 = K[1][0]
+
+    self.A_K_0 = self.A0_0 - self.K0_0 * self.C0_0
+    self.A_K_1 = self.A0_1 - self.K0_0 * self.C0_1
+    self.A_K_2 = self.A1_0 - self.K1_0 * self.C0_0
+    self.A_K_3 = self.A1_1 - self.K1_0 * self.C0_1
+
+  def update(self, meas):
+    cdef double x0_0 = self.A_K_0 * self.x0_0 + self.A_K_1 * self.x1_0 + self.K0_0 * meas
+    cdef double x1_0 = self.A_K_2 * self.x0_0 + self.A_K_3 * self.x1_0 + self.K1_0 * meas
+    self.x0_0 = x0_0
+    self.x1_0 = x1_0
+
+    return [self.x0_0, self.x1_0]
+
+  @property
+  def x(self):
+    return [[self.x0_0], [self.x1_0]]
+
+  @x.setter
+  def x(self, x):
+    self.x0_0 = x[0][0]
+    self.x1_0 = x[1][0]

common/kalman/simple_kalman_old.py

@@ -0,0 +1,23 @@
+import numpy as np
+
+
+class KF1D:
+  # this EKF assumes constant covariance matrix, so calculations are much simpler
+  # the Kalman gain also needs to be precomputed using the control module
+
+  def __init__(self, x0, A, C, K):
+    self.x = x0
+    self.A = A
+    self.C = C
+    self.K = K
+
+    self.A_K = self.A - np.dot(self.K, self.C)
+
+    # K matrix needs to  be pre-computed as follow:
+    # import control
+    # (x, l, K) = control.dare(np.transpose(self.A), np.transpose(self.C), Q, R)
+    # self.K = np.transpose(K)
+
+  def update(self, meas):
+    self.x = np.dot(self.A_K, self.x) + np.dot(self.K, meas)
+    return self.x

common/kalman/simple_kalman_setup.py

@@ -0,0 +1,5 @@
+from distutils.core import setup, Extension
+from Cython.Build import cythonize
+
+setup(name='Simple Kalman Implementation',
+      ext_modules=cythonize(Extension("simple_kalman_impl", ["simple_kalman_impl.pyx"])))

common/kalman/tests/test_ekf.py

@@ -0,0 +1,116 @@
+import numpy as np
+import numpy.matlib
+import unittest
+import timeit
+
+from common.kalman.ekf import EKF, SimpleSensor, FastEKF1D
+
+class TestEKF(EKF):
+  def __init__(self, var_init, Q):
+    super(TestEKF, self).__init__(False)
+    self.identity = numpy.matlib.identity(2)
+    self.state = numpy.matlib.zeros((2, 1))
+    self.covar = self.identity * var_init
+
+    self.process_noise = numpy.matlib.diag(Q)
+
+  def calc_transfer_fun(self, dt):
+    tf = numpy.matlib.identity(2)
+    tf[0, 1] = dt
+    return tf, tf
+
+
+class EKFTest(unittest.TestCase):
+  def test_update_scalar(self):
+    ekf = TestEKF(1e3, [0.1, 1])
+    dt = 1. / 100
+
+    sensor = SimpleSensor(0, 1, 2)
+    readings = map(sensor.read, np.arange(100, 300))
+
+    for reading in readings:
+      ekf.update_scalar(reading)
+      ekf.predict(dt)
+
+    np.testing.assert_allclose(ekf.state, [[300], [100]], 1e-4)
+    np.testing.assert_allclose(
+      ekf.covar,
+      np.asarray([[0.0563, 0.10278], [0.10278, 0.55779]]),
+      atol=1e-4)
+
+  def test_unbiased(self):
+    ekf = TestEKF(1e3, [0., 0.])
+    dt = np.float64(1. / 100)
+
+    sensor = SimpleSensor(0, 1, 2)
+    readings = map(sensor.read, np.arange(1000))
+
+    for reading in readings:
+      ekf.update_scalar(reading)
+      ekf.predict(dt)
+
+    np.testing.assert_allclose(ekf.state, [[1000.], [100.]], 1e-4)
+
+
+class FastEKF1DTest(unittest.TestCase):
+  def test_correctness(self):
+    dt = 1. / 100
+    reading = SimpleSensor(0, 1, 2).read(100)
+
+    ekf = TestEKF(1e3, [0.1, 1])
+    fast_ekf = FastEKF1D(dt, 1e3, [0.1, 1])
+
+    ekf.update_scalar(reading)
+    fast_ekf.update_scalar(reading)
+    self.assertAlmostEqual(ekf.state[0]   , fast_ekf.state[0])
+    self.assertAlmostEqual(ekf.state[1]   , fast_ekf.state[1])
+    self.assertAlmostEqual(ekf.covar[0, 0], fast_ekf.covar[0])
+    self.assertAlmostEqual(ekf.covar[0, 1], fast_ekf.covar[2])
+    self.assertAlmostEqual(ekf.covar[1, 1], fast_ekf.covar[1])
+
+    ekf.predict(dt)
+    fast_ekf.predict(dt)
+    self.assertAlmostEqual(ekf.state[0]   , fast_ekf.state[0])
+    self.assertAlmostEqual(ekf.state[1]   , fast_ekf.state[1])
+    self.assertAlmostEqual(ekf.covar[0, 0], fast_ekf.covar[0])
+    self.assertAlmostEqual(ekf.covar[0, 1], fast_ekf.covar[2])
+    self.assertAlmostEqual(ekf.covar[1, 1], fast_ekf.covar[1])
+
+  def test_speed(self):
+    setup = """
+import numpy as np
+from common.kalman.tests.test_ekf import TestEKF
+from common.kalman.ekf import SimpleSensor, FastEKF1D
+
+dt = 1. / 100
+reading = SimpleSensor(0, 1, 2).read(100)
+
+var_init, Q = 1e3, [0.1, 1]
+ekf = TestEKF(var_init, Q)
+fast_ekf = FastEKF1D(dt, var_init, Q)
+    """
+
+    timeit.timeit("""
+ekf.update_scalar(reading)
+ekf.predict(dt)
+    """, setup=setup, number=1000)
+
+    ekf_speed = timeit.timeit("""
+ekf.update_scalar(reading)
+ekf.predict(dt)
+    """, setup=setup, number=20000)
+
+    timeit.timeit("""
+fast_ekf.update_scalar(reading)
+fast_ekf.predict(dt)
+    """, setup=setup, number=1000)
+
+    fast_ekf_speed = timeit.timeit("""
+fast_ekf.update_scalar(reading)
+fast_ekf.predict(dt)
+    """, setup=setup, number=20000)
+
+    assert fast_ekf_speed < ekf_speed / 4
+
+if __name__ == "__main__":
+  unittest.main()

common/kalman/tests/test_simple_kalman.py

@@ -0,0 +1,85 @@
+import unittest
+import random
+import timeit
+import numpy as np
+
+from common.kalman.simple_kalman import KF1D
+from common.kalman.simple_kalman_old import KF1D as KF1D_old
+
+
+class TestSimpleKalman(unittest.TestCase):
+  def setUp(self):
+    dt = 0.01
+    x0_0 = 0.0
+    x1_0 = 0.0
+    A0_0 = 1.0
+    A0_1 = dt
+    A1_0 = 0.0
+    A1_1 = 1.0
+    C0_0 = 1.0
+    C0_1 = 0.0
+    K0_0 = 0.12287673
+    K1_0 = 0.29666309
+
+    self.kf_old = KF1D_old(x0=np.matrix([[x0_0], [x1_0]]),
+                           A=np.matrix([[A0_0, A0_1], [A1_0, A1_1]]),
+                           C=np.matrix([C0_0, C0_1]),
+                           K=np.matrix([[K0_0], [K1_0]]))
+
+    self.kf = KF1D(x0=[[x0_0], [x1_0]],
+                   A=[[A0_0, A0_1], [A1_0, A1_1]],
+                   C=[C0_0, C0_1],
+                   K=[[K0_0], [K1_0]])
+
+  def test_getter_setter(self):
+    self.kf.x = [[1.0], [1.0]]
+    self.assertEqual(self.kf.x, [[1.0], [1.0]])
+
+  def update_returns_state(self):
+      x = self.kf.update(100)
+      self.assertEqual(x, self.kf.x)
+
+  def test_old_equal_new(self):
+    for _ in range(1000):
+      v_wheel = random.uniform(0, 200)
+
+      x_old = self.kf_old.update(v_wheel)
+      x = self.kf.update(v_wheel)
+
+      # Compare the output x, verify that the error is less than 1e-4
+      self.assertAlmostEqual(x_old[0], x[0])
+      self.assertAlmostEqual(x_old[1], x[1])
+
+
+  def test_new_is_faster(self):
+    setup = """
+import numpy as np
+
+from common.kalman.simple_kalman import KF1D
+from common.kalman.simple_kalman_old import KF1D as KF1D_old
+
+dt = 0.01
+x0_0 = 0.0
+x1_0 = 0.0
+A0_0 = 1.0
+A0_1 = dt
+A1_0 = 0.0
+A1_1 = 1.0
+C0_0 = 1.0
+C0_1 = 0.0
+K0_0 = 0.12287673
+K1_0 = 0.29666309
+
+kf_old = KF1D_old(x0=np.matrix([[x0_0], [x1_0]]),
+                  A=np.matrix([[A0_0, A0_1], [A1_0, A1_1]]),
+                  C=np.matrix([C0_0, C0_1]),
+                  K=np.matrix([[K0_0], [K1_0]]))
+
+kf = KF1D(x0=[[x0_0], [x1_0]],
+          A=[[A0_0, A0_1], [A1_0, A1_1]],
+          C=[C0_0, C0_1],
+          K=[[K0_0], [K1_0]])
+    """
+    kf_speed = timeit.timeit("kf.update(1234)", setup=setup, number=10000)
+    kf_old_speed = timeit.timeit("kf_old.update(1234)", setup=setup, number=10000)
+    self.assertTrue(kf_speed < kf_old_speed / 4)

common/logging_extra.py

@@ -1,23 +1,14 @@
-import io
 import os
 import sys
 import copy
 import json
-import time
-import uuid
 import socket
 import logging
-import traceback
-import numpy as np
 from threading import local
 from collections import OrderedDict
 from contextlib import contextmanager
 
-LOG_TIMESTAMPS = "LOG_TIMESTAMPS" in os.environ
-
 def json_handler(obj):
-  if isinstance(obj, np.bool_):
-    return bool(obj)
   # if isinstance(obj, (datetime.date, datetime.time)):
   #   return obj.isoformat()
   return repr(obj)
@@ -69,57 +60,14 @@ class SwagFormatter(logging.Formatter):
     return record_dict
 
   def format(self, record):
-    if self.swaglogger is None:
-      raise Exception("must set swaglogger before calling format()")
     return json_robust_dumps(self.format_dict(record))
 
-class SwagLogFileFormatter(SwagFormatter):
-  def fix_kv(self, k, v):
-    # append type to names to preserve legacy naming in logs
-    # avoids overlapping key namespaces with different types
-    # e.g. log.info() creates 'msg' -> 'msg$s'
-    #      log.event() creates 'msg.health.logMonoTime' -> 'msg.health.logMonoTime$i'
-    #      because overlapping namespace 'msg' caused problems
-    if isinstance(v, (str, bytes)):
-      k += "$s"
-    elif isinstance(v, float):
-      k += "$f"
-    elif isinstance(v, bool):
-      k += "$b"
-    elif isinstance(v, int):
-      k += "$i"
-    elif isinstance(v, dict):
-      nv = {}
-      for ik, iv in v.items():
-        ik, iv = self.fix_kv(ik, iv)
-        nv[ik] = iv
-      v = nv
-    elif isinstance(v, list):
-      k += "$a"
-    return k, v
-
-  def format(self, record):
-    if isinstance(record, str):
-      v = json.loads(record)
-    else:
-      v = self.format_dict(record)
-
-    mk, mv = self.fix_kv('msg', v['msg'])
-    del v['msg']
-    v[mk] = mv
-    v['id'] = uuid.uuid4().hex
-
-    return json_robust_dumps(v)
-
 class SwagErrorFilter(logging.Filter):
   def filter(self, record):
     return record.levelno < logging.ERROR
 
-def _tmpfunc():
-  return 0
-
-def _srcfile():
-  return os.path.normcase(_tmpfunc.__code__.co_filename)
+_tmpfunc = lambda: 0
+_srcfile = os.path.normcase(_tmpfunc.__code__.co_filename)
 
 class SwagLogger(logging.Logger):
   def __init__(self):
@@ -130,6 +78,28 @@ class SwagLogger(logging.Logger):
     self.log_local = local()
     self.log_local.ctx = {}
 
+  def findCaller(self, stack_info=None):
+    """
+      Find the stack frame of the caller so that we can note the source
+      file name, line number and function name.
+      """
+    # f = currentframe()
+    f = sys._getframe(3)
+    #On some versions of IronPython, currentframe() returns None if
+    #IronPython isn't run with -X:Frames.
+    if f is not None:
+      f = f.f_back
+    rv = "(unknown file)", 0, "(unknown function)"
+    while hasattr(f, "f_code"):
+      co = f.f_code
+      filename = os.path.normcase(co.co_filename)
+      if filename in (logging._srcfile, _srcfile):
+        f = f.f_back
+        continue
+      rv = (co.co_filename, f.f_lineno, co.co_name)
+      break
+    return rv
+
   def local_ctx(self):
     try:
       return self.log_local.ctx
@@ -156,65 +126,20 @@ class SwagLogger(logging.Logger):
   def bind_global(self, **kwargs):
     self.global_ctx.update(kwargs)
 
-  def event(self, event, *args, **kwargs):
+  def event(self, event_name, *args, **kwargs):
     evt = NiceOrderedDict()
-    evt['event'] = event
+    evt['event'] = event_name
     if args:
       evt['args'] = args
     evt.update(kwargs)
+    ctx = self.get_ctx()
+    if ctx:
+      evt['ctx'] = self.get_ctx()
     if 'error' in kwargs:
       self.error(evt)
-    elif 'debug' in kwargs:
-      self.debug(evt)
     else:
       self.info(evt)
 
-  def timestamp(self, event_name):
-    if LOG_TIMESTAMPS:
-      t = time.monotonic()
-      tstp = NiceOrderedDict()
-      tstp['timestamp'] = NiceOrderedDict()
-      tstp['timestamp']["event"] = event_name
-      tstp['timestamp']["time"] = t*1e9
-      self.debug(tstp)
-
-  def findCaller(self, stack_info=False, stacklevel=1):
-    """
-    Find the stack frame of the caller so that we can note the source
-    file name, line number and function name.
-    """
-    f = sys._getframe(3)
-    #On some versions of IronPython, currentframe() returns None if
-    #IronPython isn't run with -X:Frames.
-    if f is not None:
-      f = f.f_back
-    orig_f = f
-    while f and stacklevel > 1:
-      f = f.f_back
-      stacklevel -= 1
-    if not f:
-      f = orig_f
-    rv = "(unknown file)", 0, "(unknown function)", None
-    while hasattr(f, "f_code"):
-      co = f.f_code
-      filename = os.path.normcase(co.co_filename)
-
-      if filename == _srcfile:
-        f = f.f_back
-        continue
-      sinfo = None
-      if stack_info:
-        sio = io.StringIO()
-        sio.write('Stack (most recent call last):\n')
-        traceback.print_stack(f, file=sio)
-        sinfo = sio.getvalue()
-        if sinfo[-1] == '\n':
-          sinfo = sinfo[:-1]
-        sio.close()
-      rv = (co.co_filename, f.f_lineno, co.co_name, sinfo)
-      break
-    return rv
-
 if __name__ == "__main__":
   log = SwagLogger()
 

common/markdown.py

@@ -1,45 +0,0 @@
-HTML_REPLACEMENTS = [
-  (r'&', r'&'),
-  (r'"', r'"'),
-]
-
-def parse_markdown(text: str, tab_length: int = 2) -> str:
-  lines = text.split("\n")
-  output: list[str] = []
-  list_level = 0
-
-  def end_outstanding_lists(level: int, end_level: int) -> int:
-    while level > end_level:
-      level -= 1
-      output.append("</ul>")
-      if level > 0:
-        output.append("</li>")
-    return end_level
-
-  for i, line in enumerate(lines):
-    if i + 1 < len(lines) and lines[i + 1].startswith("==="):  # heading
-      output.append(f"<h1>{line}</h1>")
-    elif line.startswith("==="):
-      pass
-    elif line.lstrip().startswith("* "):  # list
-      line_level = 1 + line.count(" " * tab_length, 0, line.index("*"))
-      if list_level >= line_level:
-        list_level = end_outstanding_lists(list_level, line_level)
-      else:
-        list_level += 1
-        if list_level > 1:
-          output[-1] = output[-1].replace("</li>", "")
-        output.append("<ul>")
-      output.append(f"<li>{line.replace('*', '', 1).lstrip()}</li>")
-    else:
-      list_level = end_outstanding_lists(list_level, 0)
-      if len(line) > 0:
-        output.append(line)
-
-  end_outstanding_lists(list_level, 0)
-  output_str = "\n".join(output) + "\n"
-
-  for (fr, to) in HTML_REPLACEMENTS:
-    output_str = output_str.replace(fr, to)
-
-  return output_str

common/mock/__init__.py

@@ -1,50 +0,0 @@
-"""
-Utilities for generating mock messages for testing.
-example in common/tests/test_mock.py
-"""
-
-
-import functools
-import threading
-from cereal.messaging import PubMaster
-from cereal.services import SERVICE_LIST
-from openpilot.common.mock.generators import generate_livePose
-from openpilot.common.realtime import Ratekeeper
-
-
-MOCK_GENERATOR = {
-  "livePose": generate_livePose
-}
-
-
-def generate_messages_loop(services: list[str], done: threading.Event):
-  pm = PubMaster(services)
-  rk = Ratekeeper(100)
-  i = 0
-  while not done.is_set():
-    for s in services:
-      should_send = i % (100/SERVICE_LIST[s].frequency) == 0
-      if should_send:
-        message = MOCK_GENERATOR[s]()
-        pm.send(s, message)
-    i += 1
-    rk.keep_time()
-
-
-def mock_messages(services: list[str] | str):
-  if isinstance(services, str):
-    services = [services]
-
-  def decorator(func):
-    @functools.wraps(func)
-    def wrapper(*args, **kwargs):
-      done = threading.Event()
-      t = threading.Thread(target=generate_messages_loop, args=(services, done))
-      t.start()
-      try:
-        return func(*args, **kwargs)
-      finally:
-        done.set()
-        t.join()
-    return wrapper
-  return decorator

common/mock/generators.py

@@ -1,14 +0,0 @@
-from cereal import messaging
-
-
-def generate_livePose():
-  msg = messaging.new_message('livePose')
-  meas = {'x': 0.0, 'y': 0.0, 'z': 0.0, 'xStd': 0.0, 'yStd': 0.0, 'zStd': 0.0, 'valid': True}
-  msg.livePose.orientationNED = meas
-  msg.livePose.velocityDevice = meas
-  msg.livePose.angularVelocityDevice = meas
-  msg.livePose.accelerationDevice = meas
-  msg.livePose.inputsOK = True
-  msg.livePose.posenetOK = True
-  msg.livePose.sensorsOK = True
-  return msg

common/numpy_fast.py

@@ -0,0 +1,18 @@
+def int_rnd(x):
+  return int(round(x))
+
+def clip(x, lo, hi):
+  return max(lo, min(hi, x))
+
+def interp(x, xp, fp):
+  N = len(xp)
+  def get_interp(xv):
+    hi = 0
+    while hi < N and xv > xp[hi]:
+      hi += 1
+    low = hi - 1
+    return fp[-1] if hi == N and xv > xp[low] else (
+      fp[0] if hi == 0 else 
+      (xv - xp[low]) * (fp[hi] - fp[low]) / (xp[hi] - xp[low]) + fp[low])
+  return [get_interp(v) for v in x] if hasattr(
+    x, '__iter__') else get_interp(x)

common/parameterized.py

@@ -1,47 +0,0 @@
-import sys
-import pytest
-import inspect
-
-
-class parameterized:
-  @staticmethod
-  def expand(cases):
-    cases = list(cases)
-
-    if not cases:
-      return lambda func: pytest.mark.skip("no parameterized cases")(func)
-
-    def decorator(func):
-      params = [p for p in inspect.signature(func).parameters if p != 'self']
-      normalized = [c if isinstance(c, tuple) else (c,) for c in cases]
-      # Infer arg count from first case so extra params (e.g. from @given) are left untouched
-      expand_params = params[: len(normalized[0])]
-      if len(expand_params) == 1:
-        return pytest.mark.parametrize(expand_params[0], [c[0] for c in normalized])(func)
-      return pytest.mark.parametrize(', '.join(expand_params), normalized)(func)
-
-    return decorator
-
-
-def parameterized_class(attrs, input_list=None):
-  if isinstance(attrs, list) and (not attrs or isinstance(attrs[0], dict)):
-    params_list = attrs
-  else:
-    assert input_list is not None
-    attr_names = (attrs,) if isinstance(attrs, str) else tuple(attrs)
-    params_list = [dict(zip(attr_names, v if isinstance(v, (tuple, list)) else (v,), strict=False)) for v in input_list]
-
-  def decorator(cls):
-    globs = sys._getframe(1).f_globals
-    for i, params in enumerate(params_list):
-      name = f"{cls.__name__}_{i}"
-      new_cls = type(name, (cls,), dict(params))
-      new_cls.__module__ = cls.__module__
-      new_cls.__test__ = True  # override inherited False so pytest collects this subclass
-      globs[name] = new_cls
-    # Don't collect the un-parametrised base, but return it so outer decorators
-    # (e.g. @pytest.mark.skip) land on it and propagate to subclasses via MRO.
-    cls.__test__ = False
-    return cls
-
-  return decorator

common/params.cc

@@ -1,242 +0,0 @@
-#include "common/params.h"
-
-#include <dirent.h>
-#include <sys/file.h>
-
-#include <algorithm>
-#include <cassert>
-#include <csignal>
-#include <unordered_map>
-
-#include "common/params_keys.h"
-#include "common/queue.h"
-#include "common/swaglog.h"
-#include "common/util.h"
-#include "system/hardware/hw.h"
-
-namespace {
-
-volatile sig_atomic_t params_do_exit = 0;
-void params_sig_handler(int signal) {
-  params_do_exit = 1;
-}
-
-int fsync_dir(const std::string &path) {
-  int result = -1;
-  int fd = HANDLE_EINTR(open(path.c_str(), O_RDONLY, 0755));
-  if (fd >= 0) {
-    result = HANDLE_EINTR(fsync(fd));
-    HANDLE_EINTR(close(fd));
-  }
-  return result;
-}
-
-bool create_params_path(const std::string &param_path, const std::string &key_path) {
-  // Make sure params path exists
-  if (!util::file_exists(param_path) && !util::create_directories(param_path, 0775)) {
-    return false;
-  }
-
-  // See if the symlink exists, otherwise create it
-  if (!util::file_exists(key_path)) {
-    // 1) Create temp folder
-    // 2) Symlink it to temp link
-    // 3) Move symlink to <params>/d
-
-    std::string tmp_path = param_path + "/.tmp_XXXXXX";
-    // this should be OK since mkdtemp just replaces characters in place
-    char *tmp_dir = mkdtemp((char *)tmp_path.c_str());
-    if (tmp_dir == NULL) {
-      return false;
-    }
-
-    std::string link_path = std::string(tmp_dir) + ".link";
-    if (symlink(tmp_dir, link_path.c_str()) != 0) {
-      return false;
-    }
-
-    // don't return false if it has been created by other
-    if (rename(link_path.c_str(), key_path.c_str()) != 0 && errno != EEXIST) {
-      return false;
-    }
-  }
-
-  return true;
-}
-
-std::string ensure_params_path(const std::string &prefix, const std::string &path = {}) {
-  std::string params_path = path.empty() ? Path::params() : path;
-  if (!create_params_path(params_path, params_path + prefix)) {
-    throw std::runtime_error(util::string_format(
-        "Failed to ensure params path, errno=%d, path=%s, param_prefix=%s",
-        errno, params_path.c_str(), prefix.c_str()));
-  }
-  return params_path;
-}
-
-class FileLock {
-public:
-  FileLock(const std::string &fn) {
-    fd_ = HANDLE_EINTR(open(fn.c_str(), O_CREAT, 0775));
-    if (fd_ < 0 || HANDLE_EINTR(flock(fd_, LOCK_EX)) < 0) {
-      LOGE("Failed to lock file %s, errno=%d", fn.c_str(), errno);
-    }
-  }
-  ~FileLock() { close(fd_); }
-
-private:
-  int fd_ = -1;
-};
-
-} // namespace
-
-
-Params::Params(const std::string &path) {
-  params_prefix = "/" + util::getenv("OPENPILOT_PREFIX", "d");
-  params_path = ensure_params_path(params_prefix, path);
-}
-
-Params::~Params() {
-  if (future.valid()) {
-    future.wait();
-  }
-  assert(queue.empty());
-}
-
-std::vector<std::string> Params::allKeys() const {
-  std::vector<std::string> ret;
-  for (auto &p : keys) {
-    ret.push_back(p.first);
-  }
-  return ret;
-}
-
-bool Params::checkKey(const std::string &key) {
-  return keys.find(key) != keys.end();
-}
-
-ParamKeyFlag Params::getKeyFlag(const std::string &key) {
-  return static_cast<ParamKeyFlag>(keys[key].flags);
-}
-
-ParamKeyType Params::getKeyType(const std::string &key) {
-  return keys[key].type;
-}
-
-std::optional<std::string> Params::getKeyDefaultValue(const std::string &key) {
-  return keys[key].default_value;
-}
-
-int Params::put(const char* key, const char* value, size_t value_size) {
-  // Information about safely and atomically writing a file: https://lwn.net/Articles/457667/
-  // 1) Create temp file
-  // 2) Write data to temp file
-  // 3) fsync() the temp file
-  // 4) rename the temp file to the real name
-  // 5) fsync() the containing directory
-  std::string tmp_path = params_path + "/.tmp_value_XXXXXX";
-  int tmp_fd = mkstemp((char*)tmp_path.c_str());
-  if (tmp_fd < 0) return -1;
-
-  int result = -1;
-  do {
-    // Write value to temp.
-    ssize_t bytes_written = HANDLE_EINTR(write(tmp_fd, value, value_size));
-    if (bytes_written < 0 || (size_t)bytes_written != value_size) {
-      result = -20;
-      break;
-    }
-
-    // fsync to force persist the changes.
-    if ((result = HANDLE_EINTR(fsync(tmp_fd))) < 0) break;
-
-    FileLock file_lock(params_path + "/.lock");
-
-    // Move temp into place.
-    if ((result = rename(tmp_path.c_str(), getParamPath(key).c_str())) < 0) break;
-
-    // fsync parent directory
-    result = fsync_dir(getParamPath());
-  } while (false);
-
-  close(tmp_fd);
-  if (result != 0) {
-    ::unlink(tmp_path.c_str());
-  }
-  return result;
-}
-
-int Params::remove(const std::string &key) {
-  FileLock file_lock(params_path + "/.lock");
-  int result = unlink(getParamPath(key).c_str());
-  if (result != 0) {
-    return result;
-  }
-  return fsync_dir(getParamPath());
-}
-
-std::string Params::get(const std::string &key, bool block) {
-  if (!block) {
-    return util::read_file(getParamPath(key));
-  } else {
-    // blocking read until successful
-    params_do_exit = 0;
-    void (*prev_handler_sigint)(int) = std::signal(SIGINT, params_sig_handler);
-    void (*prev_handler_sigterm)(int) = std::signal(SIGTERM, params_sig_handler);
-
-    std::string value;
-    while (!params_do_exit) {
-      if (value = util::read_file(getParamPath(key)); !value.empty()) {
-        break;
-      }
-      util::sleep_for(100);  // 0.1 s
-    }
-
-    std::signal(SIGINT, prev_handler_sigint);
-    std::signal(SIGTERM, prev_handler_sigterm);
-    return value;
-  }
-}
-
-std::map<std::string, std::string> Params::readAll() {
-  FileLock file_lock(params_path + "/.lock");
-  return util::read_files_in_dir(getParamPath());
-}
-
-void Params::clearAll(ParamKeyFlag key_flag) {
-  FileLock file_lock(params_path + "/.lock");
-
-  // 1) delete params of key_flag
-  // 2) delete files that are not defined in the keys.
-  if (DIR *d = opendir(getParamPath().c_str())) {
-    struct dirent *de = NULL;
-    while ((de = readdir(d))) {
-      if (de->d_type != DT_DIR) {
-        auto it = keys.find(de->d_name);
-        if (it == keys.end() || (it->second.flags & key_flag)) {
-          unlink(getParamPath(de->d_name).c_str());
-        }
-      }
-    }
-    closedir(d);
-  }
-
-  fsync_dir(getParamPath());
-}
-
-void Params::putNonBlocking(const std::string &key, const std::string &val) {
-   queue.push(std::make_pair(key, val));
-  // start thread on demand
-  if (!future.valid() || future.wait_for(std::chrono::milliseconds(0)) == std::future_status::ready) {
-    future = std::async(std::launch::async, &Params::asyncWriteThread, this);
-  }
-}
-
-void Params::asyncWriteThread() {
-  // TODO: write the latest one if a key has multiple values in the queue.
-  std::pair<std::string, std::string> p;
-  while (queue.try_pop(p, 0)) {
-    // Params::put is Thread-Safe
-    put(p.first, p.second);
-  }
-}

common/params.h

@@ -1,90 +0,0 @@
-#pragma once
-
-#include <future>
-#include <map>
-#include <optional>
-#include <string>
-#include <tuple>
-#include <utility>
-#include <vector>
-
-#include "common/queue.h"
-
-enum ParamKeyFlag {
-  PERSISTENT = 0x02,
-  CLEAR_ON_MANAGER_START = 0x04,
-  CLEAR_ON_ONROAD_TRANSITION = 0x08,
-  CLEAR_ON_OFFROAD_TRANSITION = 0x10,
-  DONT_LOG = 0x20,
-  DEVELOPMENT_ONLY = 0x40,
-  CLEAR_ON_IGNITION_ON = 0x80,
-  ALL = 0xFFFFFFFF
-};
-
-enum ParamKeyType {
-  STRING = 0, // must be utf-8 decodable
-  BOOL = 1,
-  INT = 2,
-  FLOAT = 3,
-  TIME = 4, // ISO 8601
-  JSON = 5,
-  BYTES = 6
-};
-
-struct ParamKeyAttributes {
-  uint32_t flags;
-  ParamKeyType type;
-  std::optional<std::string> default_value = std::nullopt;
-};
-
-class Params {
-public:
-  explicit Params(const std::string &path = {});
-  ~Params();
-  // Not copyable.
-  Params(const Params&) = delete;
-  Params& operator=(const Params&) = delete;
-
-  std::vector<std::string> allKeys() const;
-  bool checkKey(const std::string &key);
-  ParamKeyFlag getKeyFlag(const std::string &key);
-  ParamKeyType getKeyType(const std::string &key);
-  std::optional<std::string> getKeyDefaultValue(const std::string &key);
-  inline std::string getParamPath(const std::string &key = {}) {
-    return params_path + params_prefix + (key.empty() ? "" : "/" + key);
-  }
-
-  // Delete a value
-  int remove(const std::string &key);
-  void clearAll(ParamKeyFlag flag);
-
-  // helpers for reading values
-  std::string get(const std::string &key, bool block = false);
-  inline bool getBool(const std::string &key, bool block = false) {
-    return get(key, block) == "1";
-  }
-  std::map<std::string, std::string> readAll();
-
-  // helpers for writing values
-  int put(const char *key, const char *val, size_t value_size);
-  inline int put(const std::string &key, const std::string &val) {
-    return put(key.c_str(), val.data(), val.size());
-  }
-  inline int putBool(const std::string &key, bool val) {
-    return put(key.c_str(), val ? "1" : "0", 1);
-  }
-  void putNonBlocking(const std::string &key, const std::string &val);
-  inline void putBoolNonBlocking(const std::string &key, bool val) {
-    putNonBlocking(key, val ? "1" : "0");
-  }
-
-private:
-  void asyncWriteThread();
-
-  std::string params_path;
-  std::string params_prefix;
-
-  // for nonblocking write
-  std::future<void> future;
-  SafeQueue<std::pair<std::string, std::string>> queue;
-};

common/params.py

@@ -1,19 +1,358 @@
-from openpilot.common.params_pyx import Params, ParamKeyFlag, ParamKeyType, UnknownKeyName
-assert Params
-assert ParamKeyFlag
-assert ParamKeyType
-assert UnknownKeyName
+#!/usr/bin/env python
+"""ROS has a parameter server, we have files.
+
+The parameter store is a persistent key value store, implemented as a directory with a writer lock.
+On Android, we store params under params_dir = /data/params. The writer lock is a file
+"<params_dir>/.lock" taken using flock(), and data is stored in a directory symlinked to by
+"<params_dir>/d".
+
+Each key, value pair is stored as a file with named <key> with contents <value>, located in
+  <params_dir>/d/<key>
+
+Readers of a single key can just open("<params_dir>/d/<key>") and read the file contents.
+Readers who want a consistent snapshot of multiple keys should take the lock.
+
+Writers should take the lock before modifying anything. Writers should also leave the DB in a
+consistent state after a crash. The implementation below does this by copying all params to a temp
+directory <params_dir>/<tmp>, then atomically symlinking <params_dir>/<d> to <params_dir>/<tmp>
+before deleting the old <params_dir>/<d> directory.
+
+Writers that only modify a single key can simply take the lock, then swap the corresponding value
+file in place without messing with <params_dir>/d.
+"""
+import time
+import os
+import errno
+import sys
+import shutil
+import fcntl
+import tempfile
+from enum import Enum
+
+
+def mkdirs_exists_ok(path):
+  try:
+    os.makedirs(path)
+  except OSError:
+    if not os.path.isdir(path):
+      raise
+
+
+class TxType(Enum):
+  PERSISTENT = 1
+  CLEAR_ON_MANAGER_START = 2
+  CLEAR_ON_CAR_START = 3
+
+
+class UnknownKeyName(Exception):
+  pass
+
+
+keys = {
+  "AccessToken": TxType.PERSISTENT,
+  "CalibrationParams": TxType.PERSISTENT,
+  "CarParams": TxType.CLEAR_ON_CAR_START,
+  "CompletedTrainingVersion": TxType.PERSISTENT,
+  "ControlsParams": TxType.PERSISTENT,
+  "DoUninstall": TxType.CLEAR_ON_MANAGER_START,
+  "DongleId": TxType.PERSISTENT,
+  "GitBranch": TxType.PERSISTENT,
+  "GitCommit": TxType.PERSISTENT,
+  "GitRemote": TxType.PERSISTENT,
+  "HasAcceptedTerms": TxType.PERSISTENT,
+  "IsDriverMonitoringEnabled": TxType.PERSISTENT,
+  "IsFcwEnabled": TxType.PERSISTENT,
+  "IsGeofenceEnabled": TxType.PERSISTENT,
+  "IsMetric": TxType.PERSISTENT,
+  "IsUpdateAvailable": TxType.PERSISTENT,
+  "IsUploadVideoOverCellularEnabled": TxType.PERSISTENT,
+  "LimitSetSpeed": TxType.PERSISTENT,
+  "LiveParameters": TxType.PERSISTENT,
+  "LongitudinalControl": TxType.PERSISTENT,
+  "Passive": TxType.PERSISTENT,
+  "RecordFront": TxType.PERSISTENT,
+  "ShouldDoUpdate": TxType.CLEAR_ON_MANAGER_START,
+  "SpeedLimitOffset": TxType.PERSISTENT,
+  "TrainingVersion": TxType.PERSISTENT,
+  "Version": TxType.PERSISTENT,
+}
+
+
+def fsync_dir(path):
+  fd = os.open(path, os.O_RDONLY)
+  try:
+    os.fsync(fd)
+  finally:
+    os.close(fd)
+
+
+class FileLock(object):
+  def __init__(self, path, create):
+    self._path = path
+    self._create = create
+    self._fd = None
+
+  def acquire(self):
+    self._fd = os.open(self._path, os.O_CREAT if self._create else 0)
+    fcntl.flock(self._fd, fcntl.LOCK_EX)
+
+  def release(self):
+    if self._fd is not None:
+      os.close(self._fd)
+      self._fd = None
+
+
+class DBAccessor(object):
+  def __init__(self, path):
+    self._path = path
+    self._vals = None
+
+  def keys(self):
+    self._check_entered()
+    return self._vals.keys()
+
+  def get(self, key):
+    self._check_entered()
+    try:
+      return self._vals[key]
+    except KeyError:
+      return None
+
+  def _get_lock(self, create):
+    lock = FileLock(os.path.join(self._path, ".lock"), create)
+    lock.acquire()
+    return lock
+
+  def _read_values_locked(self):
+    """Callers should hold a lock while calling this method."""
+    vals = {}
+    try:
+      data_path = self._data_path()
+      keys = os.listdir(data_path)
+      for key in keys:
+        with open(os.path.join(data_path, key), "rb") as f:
+          vals[key] = f.read()
+    except (OSError, IOError) as e:
+      # Either the DB hasn't been created yet, or somebody wrote a bug and left the DB in an
+      # inconsistent state. Either way, return empty.
+      if e.errno == errno.ENOENT:
+        return {}
+
+    return vals
+
+  def _data_path(self):
+    return os.path.join(self._path, "d")
+
+  def _check_entered(self):
+    if self._vals is None:
+      raise Exception("Must call __enter__ before using DB")
+
+
+class DBReader(DBAccessor):
+  def __enter__(self):
+    try:
+      lock = self._get_lock(False)
+    except OSError as e:
+      # Do not create lock if it does not exist.
+      if e.errno == errno.ENOENT:
+        self._vals = {}
+        return self
+
+    try:
+      # Read everything.
+      self._vals = self._read_values_locked()
+      return self
+    finally:
+      lock.release()
+
+  def __exit__(self, type, value, traceback): pass
+
+
+class DBWriter(DBAccessor):
+  def __init__(self, path):
+    super(DBWriter, self).__init__(path)
+    self._lock = None
+    self._prev_umask = None
+
+  def put(self, key, value):
+    self._vals[key] = value
+
+  def delete(self, key):
+    self._vals.pop(key, None)
+
+  def __enter__(self):
+    mkdirs_exists_ok(self._path)
+
+    # Make sure we can write and that permissions are correct.
+    self._prev_umask = os.umask(0)
+
+    try:
+      os.chmod(self._path, 0o777)
+      self._lock = self._get_lock(True)
+      self._vals = self._read_values_locked()
+    except:
+      os.umask(self._prev_umask)
+      self._prev_umask = None
+      raise
+
+    return self
+
+  def __exit__(self, type, value, traceback):
+    self._check_entered()
+
+    try:
+      # data_path refers to the externally used path to the params. It is a symlink.
+      # old_data_path is the path currently pointed to by data_path.
+      # tempdir_path is a path where the new params will go, which the new data path will point to.
+      # new_data_path is a temporary symlink that will atomically overwrite data_path.
+      #
+      # The current situation is:
+      #   data_path -> old_data_path
+      # We're going to write params data to tempdir_path
+      #   tempdir_path -> params data
+      # Then point new_data_path to tempdir_path
+      #   new_data_path -> tempdir_path
+      # Then atomically overwrite data_path with new_data_path
+      #   data_path -> tempdir_path
+      old_data_path = None
+      new_data_path = None
+      tempdir_path = tempfile.mkdtemp(prefix=".tmp", dir=self._path)
+
+      try:
+        # Write back all keys.
+        os.chmod(tempdir_path, 0o777)
+        for k, v in self._vals.items():
+          with open(os.path.join(tempdir_path, k), "wb") as f:
+            f.write(v)
+            f.flush()
+            os.fsync(f.fileno())
+        fsync_dir(tempdir_path)
+
+        data_path = self._data_path()
+        try:
+          old_data_path = os.path.join(self._path, os.readlink(data_path))
+        except (OSError, IOError):
+          # NOTE(mgraczyk): If other DB implementations have bugs, this could cause
+          #                 copies to be left behind, but we still want to overwrite.
+          pass
+
+        new_data_path = "{}.link".format(tempdir_path)
+        os.symlink(os.path.basename(tempdir_path), new_data_path)
+        os.rename(new_data_path, data_path)
+        fsync_dir(self._path)
+      finally:
+        # If the rename worked, we can delete the old data. Otherwise delete the new one.
+        success = new_data_path is not None and os.path.exists(data_path) and (
+          os.readlink(data_path) == os.path.basename(tempdir_path))
+
+        if success:
+          if old_data_path is not None:
+            shutil.rmtree(old_data_path)
+        else:
+          shutil.rmtree(tempdir_path)
+
+        # Regardless of what happened above, there should be no link at new_data_path.
+        if new_data_path is not None and os.path.islink(new_data_path):
+          os.remove(new_data_path)
+    finally:
+      os.umask(self._prev_umask)
+      self._prev_umask = None
+
+      # Always release the lock.
+      self._lock.release()
+      self._lock = None
+
+
+def read_db(params_path, key):
+  path = "%s/d/%s" % (params_path, key)
+  try:
+    with open(path, "rb") as f:
+      return f.read()
+  except IOError:
+    return None
+
+def write_db(params_path, key, value):
+  prev_umask = os.umask(0)
+  lock = FileLock(params_path+"/.lock", True)
+  lock.acquire()
+
+  try:
+    tmp_path = tempfile.mktemp(prefix=".tmp", dir=params_path)
+    with open(tmp_path, "wb") as f:
+      f.write(value)
+      f.flush()
+      os.fsync(f.fileno())
+
+    path = "%s/d/%s" % (params_path, key)
+    os.rename(tmp_path, path)
+    fsync_dir(os.path.dirname(path))
+  finally:
+    os.umask(prev_umask)
+    lock.release()
+
+class Params(object):
+  def __init__(self, db='/data/params'):
+    self.db = db
+
+    # create the database if it doesn't exist...
+    if not os.path.exists(self.db+"/d"):
+      with self.transaction(write=True):
+        pass
+
+  def transaction(self, write=False):
+    if write:
+      return DBWriter(self.db)
+    else:
+      return DBReader(self.db)
+
+  def _clear_keys_with_type(self, tx_type):
+    with self.transaction(write=True) as txn:
+      for key in keys:
+        if keys[key] == tx_type:
+          txn.delete(key)
+
+  def manager_start(self):
+    self._clear_keys_with_type(TxType.CLEAR_ON_MANAGER_START)
+
+  def car_start(self):
+    self._clear_keys_with_type(TxType.CLEAR_ON_CAR_START)
+
+  def delete(self, key):
+    with self.transaction(write=True) as txn:
+      txn.delete(key)
+
+  def get(self, key, block=False):
+    if key not in keys:
+      raise UnknownKeyName(key)
+
+    while 1:
+      ret = read_db(self.db, key)
+      if not block or ret is not None:
+        break
+      # is polling really the best we can do?
+      time.sleep(0.05)
+    return ret
+
+  def put(self, key, dat):
+    if key not in keys:
+      raise UnknownKeyName(key)
+
+    write_db(self.db, key, dat)
 
 if __name__ == "__main__":
-  import sys
-
   params = Params()
-  key = sys.argv[1]
-  assert params.check_key(key), f"unknown param: {key}"
+  if len(sys.argv) > 2:
+    params.put(sys.argv[1], sys.argv[2])
+  else:
+    for k in keys:
+      pp = params.get(k)
+      if pp is None:
+        print("%s is None" % k)
+      elif all(ord(c) < 128 and ord(c) >= 32 for c in pp):
+        print("%s = %s" % (k, pp))
+      else:
+        print("%s = %s" % (k, pp.encode("hex")))
 
-  if len(sys.argv) == 3:
-    val = sys.argv[2]
-    print(f"SET: {key} = {val}")
-    params.put(key, val)
-  elif len(sys.argv) == 2:
-    print(f"GET: {key} = {params.get(key)}")
+  # Test multiprocess:
+  # seq 0 100000 | xargs -P20 -I{} python common/params.py DongleId {} && sleep 0.05
+  # while python common/params.py DongleId; do sleep 0.05; done

common/params_keys.h

@@ -1,165 +0,0 @@
-#pragma once
-
-#include <string>
-#include <unordered_map>
-
-#include "cereal/gen/cpp/log.capnp.h"
-
-inline static std::unordered_map<std::string, ParamKeyAttributes> keys = {
-    {"AccessToken", {CLEAR_ON_MANAGER_START | DONT_LOG, STRING}},
-    {"AdbEnabled", {PERSISTENT, BOOL}},
-    {"AlwaysOnDM", {PERSISTENT, BOOL}},
-    {"ApiCache_Device", {PERSISTENT, STRING}},
-    {"ApiCache_FirehoseStats", {PERSISTENT, JSON}},
-    {"AssistNowToken", {PERSISTENT, STRING}},
-    {"AthenadPid", {PERSISTENT, INT}},
-    {"AthenadUploadQueue", {PERSISTENT, JSON}},
-    {"AthenadRecentlyViewedRoutes", {PERSISTENT, STRING}},
-    {"BootCount", {PERSISTENT, INT}},
-    {"CalibrationParams", {PERSISTENT, BYTES}},
-    {"CameraDebugExpGain", {CLEAR_ON_MANAGER_START, STRING}},
-    {"CameraDebugExpTime", {CLEAR_ON_MANAGER_START, STRING}},
-    {"CarBatteryCapacity", {PERSISTENT, INT}},
-    {"CarParams", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, BYTES}},
-    {"CarParamsCache", {CLEAR_ON_MANAGER_START, BYTES}},
-    {"CarParamsPersistent", {PERSISTENT, BYTES}},
-    {"CarParamsPrevRoute", {PERSISTENT, BYTES}},
-    {"CompletedTrainingVersion", {PERSISTENT, STRING, "0"}},
-    {"ControlsReady", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, BOOL}},
-    {"CurrentBootlog", {PERSISTENT, STRING}},
-    {"CurrentRoute", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, STRING}},
-    {"DisableLogging", {PERSISTENT, BOOL, "0"}},
-    {"DisablePowerDown", {PERSISTENT, BOOL}},
-    {"DisableUpdates", {PERSISTENT, BOOL}},
-    {"DisengageOnAccelerator", {PERSISTENT, BOOL, "0"}},
-    {"DongleId", {PERSISTENT, STRING}},
-    {"DoReboot", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"DoShutdown", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"DoUninstall", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"DriverTooDistracted", {CLEAR_ON_MANAGER_START | CLEAR_ON_IGNITION_ON, BOOL}},
-    {"AlphaLongitudinalEnabled", {PERSISTENT | DEVELOPMENT_ONLY, BOOL}},
-    {"ExperimentalMode", {PERSISTENT, BOOL}},
-    {"ExperimentalModeConfirmed", {PERSISTENT, BOOL}},
-    {"FirmwareQueryDone", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, BOOL}},
-    {"ForcePowerDown", {PERSISTENT, BOOL}},
-    {"GitBranch", {PERSISTENT, STRING}},
-    {"GitCommit", {PERSISTENT, STRING}},
-    {"GitCommitDate", {PERSISTENT, STRING}},
-    {"GitDiff", {PERSISTENT, STRING}},
-    {"GithubSshKeys", {PERSISTENT, STRING}},
-    {"GithubUsername", {PERSISTENT, STRING}},
-    {"GitRemote", {PERSISTENT, STRING}},
-    {"GsmApn", {PERSISTENT, STRING}},
-    {"GsmMetered", {PERSISTENT, BOOL, "1"}},
-    {"GsmRoaming", {PERSISTENT, BOOL}},
-    {"HardwareSerial", {PERSISTENT, STRING}},
-    {"HasAcceptedTerms", {PERSISTENT, STRING, "0"}},
-    {"InstallDate", {PERSISTENT, TIME}},
-    {"IsDriverViewEnabled", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"IsEngaged", {PERSISTENT, BOOL}},
-    {"IsLdwEnabled", {PERSISTENT, BOOL}},
-    {"IsMetric", {PERSISTENT, BOOL}},
-    {"IsOffroad", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"IsOnroad", {PERSISTENT, BOOL}},
-    {"IsRhdDetected", {PERSISTENT, BOOL}},
-    {"IsReleaseBranch", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"IsTakingSnapshot", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"IsTestedBranch", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"JoystickDebugMode", {CLEAR_ON_MANAGER_START | CLEAR_ON_OFFROAD_TRANSITION, BOOL}},
-    {"LanguageSetting", {PERSISTENT, STRING, "en"}},
-    {"LastAthenaPingTime", {CLEAR_ON_MANAGER_START, INT}},
-    {"LastGPSPosition", {PERSISTENT, STRING}},
-    {"LastManagerExitReason", {CLEAR_ON_MANAGER_START, STRING}},
-    {"LastOffroadStatusPacket", {CLEAR_ON_MANAGER_START | CLEAR_ON_OFFROAD_TRANSITION, JSON}},
-    {"LastAgnosPowerMonitorShutdown", {CLEAR_ON_MANAGER_START, STRING}},
-    {"LastPowerDropDetected", {CLEAR_ON_MANAGER_START, STRING}},
-    {"LastUpdateException", {CLEAR_ON_MANAGER_START, STRING}},
-    {"LastUpdateRouteCount", {PERSISTENT, INT, "0"}},
-    {"LastUpdateTime", {PERSISTENT, TIME}},
-    {"LastUpdateUptimeOnroad", {PERSISTENT, FLOAT, "0.0"}},
-    {"LiveDelay", {PERSISTENT, BYTES}},
-    {"LiveParameters", {PERSISTENT, JSON}},
-    {"LiveParametersV2", {PERSISTENT, BYTES}},
-    {"LiveTorqueParameters", {PERSISTENT | DONT_LOG, BYTES}},
-    {"LocationFilterInitialState", {PERSISTENT, BYTES}},
-    {"LongitudinalManeuverMode", {CLEAR_ON_MANAGER_START | CLEAR_ON_OFFROAD_TRANSITION, BOOL}},
-    {"LongitudinalPersonality", {PERSISTENT, INT, std::to_string(static_cast<int>(cereal::LongitudinalPersonality::STANDARD))}},
-    {"NetworkMetered", {PERSISTENT, BOOL}},
-    {"ObdMultiplexingChanged", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, BOOL}},
-    {"ObdMultiplexingEnabled", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, BOOL}},
-    {"Offroad_CarUnrecognized", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, JSON}},
-    {"Offroad_ConnectivityNeeded", {CLEAR_ON_MANAGER_START, JSON}},
-    {"Offroad_ConnectivityNeededPrompt", {CLEAR_ON_MANAGER_START, JSON}},
-    {"Offroad_ExcessiveActuation", {PERSISTENT, JSON}},
-    {"Offroad_IsTakingSnapshot", {CLEAR_ON_MANAGER_START, JSON}},
-    {"Offroad_NeosUpdate", {CLEAR_ON_MANAGER_START, JSON}},
-    {"Offroad_NoFirmware", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, JSON}},
-    {"Offroad_Recalibration", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, JSON}},
-    {"Offroad_TemperatureTooHigh", {CLEAR_ON_MANAGER_START, JSON}},
-    {"Offroad_UnregisteredHardware", {CLEAR_ON_MANAGER_START, JSON}},
-    {"Offroad_UpdateFailed", {CLEAR_ON_MANAGER_START, JSON}},
-    {"Offroad_DriverMonitoringUncertain", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, JSON}},
-    {"OnroadCycleRequested", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"OpenpilotEnabledToggle", {PERSISTENT, BOOL, "1"}},
-    {"PandaHeartbeatLost", {CLEAR_ON_MANAGER_START | CLEAR_ON_OFFROAD_TRANSITION, BOOL}},
-    {"PandaSomResetTriggered", {CLEAR_ON_MANAGER_START | CLEAR_ON_OFFROAD_TRANSITION, BOOL}},
-    {"PandaSignatures", {CLEAR_ON_MANAGER_START, BYTES}},
-    {"PrimeType", {PERSISTENT, INT}},
-    {"RecordAudio", {PERSISTENT, BOOL}},
-    {"RecordAudioFeedback", {PERSISTENT, BOOL, "0"}},
-    {"RecordFront", {PERSISTENT, BOOL}},
-    {"RecordFrontLock", {PERSISTENT, BOOL}},  // for the internal fleet
-    {"SecOCKey", {PERSISTENT | DONT_LOG, STRING}},
-    {"ShowDebugInfo", {PERSISTENT, BOOL}},
-    {"RouteCount", {PERSISTENT, INT, "0"}},
-    {"SnoozeUpdate", {CLEAR_ON_MANAGER_START | CLEAR_ON_OFFROAD_TRANSITION, BOOL}},
-    {"SshEnabled", {PERSISTENT, BOOL}},
-    {"UbloxAvailable", {PERSISTENT, BOOL}},
-    {"UpdateAvailable", {CLEAR_ON_MANAGER_START | CLEAR_ON_ONROAD_TRANSITION, BOOL}},
-    {"UpdateFailedCount", {CLEAR_ON_MANAGER_START, INT}},
-    {"UpdaterAvailableBranches", {PERSISTENT, STRING}},
-    {"UpdaterCurrentDescription", {CLEAR_ON_MANAGER_START, STRING}},
-    {"UpdaterCurrentReleaseNotes", {CLEAR_ON_MANAGER_START, BYTES}},
-    {"UpdaterFetchAvailable", {CLEAR_ON_MANAGER_START, BOOL}},
-    {"UpdaterNewDescription", {CLEAR_ON_MANAGER_START, STRING}},
-    {"UpdaterNewReleaseNotes", {CLEAR_ON_MANAGER_START, BYTES}},
-    {"UpdaterState", {CLEAR_ON_MANAGER_START, STRING}},
-    {"UpdaterTargetBranch", {CLEAR_ON_MANAGER_START, STRING}},
-    {"UpdaterLastFetchTime", {PERSISTENT, TIME}},
-    {"UptimeOffroad", {PERSISTENT, FLOAT, "0.0"}},
-    {"UptimeOnroad", {PERSISTENT, FLOAT, "0.0"}},
-    {"Version", {PERSISTENT, STRING}},
-    {"dp_dev_last_log", {CLEAR_ON_ONROAD_TRANSITION, STRING}},
-    {"dp_dev_reset_conf", {CLEAR_ON_MANAGER_START, BOOL, "0"}},
-    {"dp_dev_go_off_road", {CLEAR_ON_MANAGER_START, BOOL, "0"}},
-    {"dp_honda_nidec_stock_long", {PERSISTENT, BOOL, "0"}},
-    {"dp_toyota_stock_lon", {PERSISTENT, BOOL, "0"}},
-    {"dp_toyota_tss1_sng", {PERSISTENT, BOOL, "0"}},
-    {"dp_vag_a0_sng", {PERSISTENT, BOOL, "0"}},
-    {"dp_vag_avoid_eps_lockout", {PERSISTENT, BOOL, "0"}},
-    {"dp_toyota_door_auto_lock_unlock", {PERSISTENT, BOOL, "0"}},
-    {"dp_dev_audible_alert_mode", {PERSISTENT, INT, "0"}},
-    {"dp_dev_auto_shutdown_in", {PERSISTENT, INT, "-5"}},
-    {"dp_dev_dashy", {PERSISTENT, BOOL, "0"}},
-    {"dp_dev_delay_loggerd", {PERSISTENT, INT, "0"}},
-    {"dp_dev_disable_connect", {PERSISTENT, BOOL, "0"}},
-    {"dp_dev_model_selected", {PERSISTENT, STRING}},
-    {"dp_dev_model_list", {PERSISTENT, JSON}},
-    {"dp_dev_is_rhd", {PERSISTENT, BOOL, "0"}},
-    {"dp_dev_beep", {PERSISTENT, BOOL, "0"}},
-    {"dp_dev_opview", {PERSISTENT, BOOL, "0"}},
-    {"dp_dev_tethering", {PERSISTENT, BOOL, "0"}},
-    {"dp_lat_alka", {PERSISTENT, BOOL, "0"}},
-    {"dp_lat_offset_cm", {PERSISTENT, INT, "0"}},
-    {"dp_lat_lca_speed", {PERSISTENT, INT, "20"}},
-    {"dp_lat_lca_auto_sec", {PERSISTENT, FLOAT, "0.0"}},
-    {"dp_lat_road_edge_detection", {PERSISTENT, BOOL, "0"}},
-    {"dp_lon_acm", {PERSISTENT, BOOL, "0"}},
-    {"dp_lon_aem", {PERSISTENT, BOOL, "0"}},
-    {"dp_lon_apm", {PERSISTENT, BOOL, "0"}},
-    {"dp_lon_ext_radar", {PERSISTENT, BOOL, "0"}},
-    {"dp_ui_display_mode", {PERSISTENT, INT, "0"}},
-    {"dp_ui_hide_hud_speed_kph", {PERSISTENT, INT, "0"}},
-    {"dp_ui_lead", {PERSISTENT, INT, "0"}},
-    {"dp_ui_rainbow", {PERSISTENT, BOOL, "0"}},
-};

common/params_pyx.pyx

@@ -1,196 +0,0 @@
-# distutils: language = c++
-# cython: language_level = 3
-import builtins
-import datetime
-import json
-from libcpp cimport bool
-from libcpp.string cimport string
-from libcpp.vector cimport vector
-from libcpp.optional cimport optional
-
-from openpilot.common.swaglog import cloudlog
-
-cdef extern from "common/params.h":
-  cpdef enum ParamKeyFlag:
-    PERSISTENT
-    CLEAR_ON_MANAGER_START
-    CLEAR_ON_ONROAD_TRANSITION
-    CLEAR_ON_OFFROAD_TRANSITION
-    DEVELOPMENT_ONLY
-    CLEAR_ON_IGNITION_ON
-    ALL
-
-  cpdef enum ParamKeyType:
-    STRING
-    BOOL
-    INT
-    FLOAT
-    TIME
-    JSON
-    BYTES
-
-  cdef cppclass c_Params "Params":
-    c_Params(string) except + nogil
-    string get(string, bool) nogil
-    bool getBool(string, bool) nogil
-    int remove(string) nogil
-    int put(string, string) nogil
-    void putNonBlocking(string, string) nogil
-    void putBoolNonBlocking(string, bool) nogil
-    int putBool(string, bool) nogil
-    bool checkKey(string) nogil
-    ParamKeyType getKeyType(string) nogil
-    optional[string] getKeyDefaultValue(string) nogil
-    string getParamPath(string) nogil
-    void clearAll(ParamKeyFlag)
-    vector[string] allKeys()
-
-PYTHON_2_CPP = {
-  (str, STRING): lambda v: v,
-  (builtins.bool, BOOL): lambda v: "1" if v else "0",
-  (int, INT): str,
-  (float, FLOAT): str,
-  (datetime.datetime, TIME): lambda v: v.isoformat(),
-  (dict, JSON): json.dumps,
-  (list, JSON): json.dumps,
-  (bytes, BYTES): lambda v: v,
-}
-CPP_2_PYTHON = {
-  STRING: lambda v: v.decode("utf-8"),
-  BOOL: lambda v: v == b"1",
-  INT: int,
-  FLOAT: float,
-  TIME: lambda v: datetime.datetime.fromisoformat(v.decode("utf-8")),
-  JSON: json.loads,
-  BYTES: lambda v: v,
-}
-
-def ensure_bytes(v):
-  return v.encode() if isinstance(v, str) else v
-
-class UnknownKeyName(Exception):
-  pass
-
-cdef class Params:
-  cdef c_Params* p
-  cdef str d
-
-  def __cinit__(self, d=""):
-    cdef string path = <string>d.encode()
-    with nogil:
-      self.p = new c_Params(path)
-    self.d = d
-
-  def __reduce__(self):
-    return (type(self), (self.d,))
-
-  def __dealloc__(self):
-    del self.p
-
-  def clear_all(self, tx_flag=ParamKeyFlag.ALL):
-    self.p.clearAll(tx_flag)
-
-  def check_key(self, key):
-    key = ensure_bytes(key)
-    if not self.p.checkKey(key):
-      raise UnknownKeyName(key)
-    return key
-
-  def python2cpp(self, proposed_type, expected_type, value, key):
-    cast = PYTHON_2_CPP.get((proposed_type, expected_type))
-    if cast:
-      return cast(value)
-    raise TypeError(f"Type mismatch while writing param {key}: {proposed_type=} {expected_type=} {value=}")
-
-  def _cpp2python(self, t, value, default, key):
-    if value is None:
-      return None
-    try:
-      return CPP_2_PYTHON[t](value)
-    except (KeyError, TypeError, ValueError):
-      cloudlog.warning(f"Failed to cast param {key} with {value=} from type {t=}")
-      return self._cpp2python(t, default, None, key)
-
-  def get(self, key, bool block=False, bool return_default=False):
-    cdef string k = self.check_key(key)
-    cdef ParamKeyType t = self.p.getKeyType(k)
-    cdef optional[string] default = self.p.getKeyDefaultValue(k)
-    cdef string val
-    with nogil:
-      val = self.p.get(k, block)
-
-    default_val = (default.value() if default.has_value() else None) if return_default else None
-    if val == b"":
-      if block:
-        # If we got no value while running in blocked mode
-        # it means we got an interrupt while waiting
-        raise KeyboardInterrupt
-      else:
-        return self._cpp2python(t, default_val, None, key)
-    return self._cpp2python(t, val, default_val, key)
-
-  def get_bool(self, key, bool block=False):
-    cdef string k = self.check_key(key)
-    cdef bool r
-    with nogil:
-      r = self.p.getBool(k, block)
-    return r
-
-  def _put_cast(self, key, dat):
-    cdef string k = self.check_key(key)
-    cdef ParamKeyType t = self.p.getKeyType(k)
-    return ensure_bytes(self.python2cpp(type(dat), t, dat, key))
-
-  def put(self, key, dat):
-    """
-    Warning: This function blocks until the param is written to disk!
-    In very rare cases this can take over a second, and your code will hang.
-    Use the put_nonblocking, put_bool_nonblocking in time sensitive code, but
-    in general try to avoid writing params as much as possible.
-    """
-    cdef string k = self.check_key(key)
-    cdef string dat_bytes = self._put_cast(key, dat)
-    with nogil:
-      self.p.put(k, dat_bytes)
-
-  def put_bool(self, key, bool val):
-    cdef string k = self.check_key(key)
-    with nogil:
-      self.p.putBool(k, val)
-
-  def put_nonblocking(self, key, dat):
-    cdef string k = self.check_key(key)
-    cdef string dat_bytes = self._put_cast(key, dat)
-    with nogil:
-      self.p.putNonBlocking(k, dat_bytes)
-
-  def put_bool_nonblocking(self, key, bool val):
-    cdef string k = self.check_key(key)
-    with nogil:
-      self.p.putBoolNonBlocking(k, val)
-
-  def remove(self, key):
-    cdef string k = self.check_key(key)
-    with nogil:
-      self.p.remove(k)
-
-  def get_param_path(self, key=""):
-    cdef string key_bytes = ensure_bytes(key)
-    return self.p.getParamPath(key_bytes).decode("utf-8")
-
-  def get_type(self, key):
-    return self.p.getKeyType(self.check_key(key))
-
-  def all_keys(self):
-    return self.p.allKeys()
-
-  def get_default_value(self, key):
-    cdef string k = self.check_key(key)
-    cdef ParamKeyType t = self.p.getKeyType(k)
-    cdef optional[string] default = self.p.getKeyDefaultValue(k)
-    return self._cpp2python(t, default.value(), None, key) if default.has_value() else None
-
-  def cpp2python(self, key, value):
-    cdef string k = self.check_key(key)
-    cdef ParamKeyType t = self.p.getKeyType(k)
-    return self._cpp2python(t, value, None, key)

common/pid.py

@@ -1,57 +0,0 @@
-import numpy as np
-from numbers import Number
-
-class PIDController:
-  def __init__(self, k_p, k_i, k_d=0., pos_limit=1e308, neg_limit=-1e308, rate=100):
-    self._k_p: list[list[float]] = [[0], [k_p]] if isinstance(k_p, Number) else k_p
-    self._k_i: list[list[float]] = [[0], [k_i]] if isinstance(k_i, Number) else k_i
-    self._k_d: list[list[float]] = [[0], [k_d]] if isinstance(k_d, Number) else k_d
-
-    self.set_limits(pos_limit, neg_limit)
-
-    self.i_dt = 1.0 / rate
-    self.speed = 0.0
-
-    self.reset()
-
-  @property
-  def k_p(self):
-    return np.interp(self.speed, self._k_p[0], self._k_p[1])
-
-  @property
-  def k_i(self):
-    return np.interp(self.speed, self._k_i[0], self._k_i[1])
-
-  @property
-  def k_d(self):
-    return np.interp(self.speed, self._k_d[0], self._k_d[1])
-
-  def reset(self):
-    self.p = 0.0
-    self.i = 0.0
-    self.d = 0.0
-    self.f = 0.0
-    self.control = 0
-
-  def set_limits(self, pos_limit, neg_limit):
-    self.pos_limit = pos_limit
-    self.neg_limit = neg_limit
-
-  def update(self, error, error_rate=0.0, speed=0.0, feedforward=0., freeze_integrator=False):
-    self.speed = speed
-    self.p = self.k_p * float(error)
-    self.d = self.k_d * error_rate
-    self.f = feedforward
-
-    if not freeze_integrator:
-      i = self.i + self.k_i * self.i_dt * error
-
-      # Don't allow windup if already clipping
-      test_control = self.p + i + self.d + self.f
-      i_upperbound = self.i if test_control > self.pos_limit else self.pos_limit
-      i_lowerbound = self.i if test_control < self.neg_limit else self.neg_limit
-      self.i = np.clip(i, i_lowerbound, i_upperbound)
-
-    control = self.p + self.i + self.d + self.f
-    self.control = np.clip(control, self.neg_limit, self.pos_limit)
-    return self.control

common/prefix.h

@@ -1,43 +0,0 @@
-#pragma once
-
-#include <cassert>
-#include <string>
-
-#include "common/params.h"
-#include "common/util.h"
-#include "system/hardware/hw.h"
-
-class OpenpilotPrefix {
-public:
-  OpenpilotPrefix(std::string prefix = {}) {
-    if (prefix.empty()) {
-      prefix = util::random_string(15);
-    }
-#ifdef __APPLE__
-    msgq_path = "/tmp/msgq_" + prefix;
-#else
-    msgq_path = "/dev/shm/msgq_" + prefix;
-#endif
-    bool ret = util::create_directories(msgq_path, 0777);
-    assert(ret);
-    setenv("OPENPILOT_PREFIX", prefix.c_str(), 1);
-  }
-
-  ~OpenpilotPrefix() {
-    auto param_path = Params().getParamPath();
-    if (util::file_exists(param_path)) {
-      std::string real_path = util::readlink(param_path);
-      util::check_system(util::string_format("rm %s -rf", real_path.c_str()));
-      unlink(param_path.c_str());
-    }
-    if (getenv("COMMA_CACHE") == nullptr) {
-      util::check_system(util::string_format("rm %s -rf", Path::download_cache_root().c_str()));
-    }
-    util::check_system(util::string_format("rm %s -rf", Path::comma_home().c_str()));
-    util::check_system(util::string_format("rm %s -rf", msgq_path.c_str()));
-    unsetenv("OPENPILOT_PREFIX");
-  }
-
-private:
-  std::string msgq_path;
-};

common/prefix.py

@@ -1,61 +0,0 @@
-import os
-import platform
-import shutil
-import uuid
-
-
-from openpilot.common.params import Params
-from openpilot.system.hardware import PC
-from openpilot.system.hardware.hw import Paths
-from openpilot.system.hardware.hw import DEFAULT_DOWNLOAD_CACHE_ROOT
-
-class OpenpilotPrefix:
-  def __init__(self, prefix: str | None = None, create_dirs_on_enter: bool = True, clean_dirs_on_exit: bool = True, shared_download_cache: bool = False):
-    self.prefix = prefix if prefix else str(uuid.uuid4().hex[0:15])
-    shm_path = "/tmp" if platform.system() == "Darwin" else "/dev/shm"
-    self.msgq_path = os.path.join(shm_path, "msgq_" + self.prefix)
-    self.create_dirs_on_enter = create_dirs_on_enter
-    self.clean_dirs_on_exit = clean_dirs_on_exit
-    self.shared_download_cache = shared_download_cache
-
-  def __enter__(self):
-    self.original_prefix = os.environ.get('OPENPILOT_PREFIX', None)
-    os.environ['OPENPILOT_PREFIX'] = self.prefix
-
-    if self.create_dirs_on_enter:
-      self.create_dirs()
-
-    if self.shared_download_cache:
-      os.environ["COMMA_CACHE"] = DEFAULT_DOWNLOAD_CACHE_ROOT
-
-    return self
-
-  def __exit__(self, exc_type, exc_obj, exc_tb):
-    if self.clean_dirs_on_exit:
-      self.clean_dirs()
-    try:
-      del os.environ['OPENPILOT_PREFIX']
-      if self.original_prefix is not None:
-        os.environ['OPENPILOT_PREFIX'] = self.original_prefix
-    except KeyError:
-      pass
-    return False
-
-  def create_dirs(self):
-    try:
-      os.mkdir(self.msgq_path)
-    except FileExistsError:
-      pass
-    os.makedirs(Paths.log_root(), exist_ok=True)
-
-  def clean_dirs(self):
-    symlink_path = Params().get_param_path()
-    if os.path.exists(symlink_path):
-      shutil.rmtree(os.path.realpath(symlink_path), ignore_errors=True)
-      os.remove(symlink_path)
-    shutil.rmtree(self.msgq_path, ignore_errors=True)
-    if PC:
-      shutil.rmtree(Paths.log_root(), ignore_errors=True)
-    if not os.environ.get("COMMA_CACHE", False):
-      shutil.rmtree(Paths.download_cache_root(), ignore_errors=True)
-    shutil.rmtree(Paths.comma_home(), ignore_errors=True)

common/profiler.py

@@ -0,0 +1,46 @@
+import time
+
+class Profiler(object):
+  def __init__(self, enabled=False):
+    self.enabled = enabled
+    self.cp = {}
+    self.cp_ignored = []
+    self.iter = 0
+    self.start_time = time.time()
+    self.last_time = self.start_time
+    self.tot = 0.
+
+  def reset(self, enabled=False):
+    self.enabled = enabled
+    self.cp = {}
+    self.cp_ignored = []
+    self.iter = 0
+    self.start_time = time.time()
+    self.last_time = self.start_time
+
+  def checkpoint(self, name, ignore=False):
+    # ignore flag needed when benchmarking threads with ratekeeper
+    if not self.enabled:
+      return
+    tt = time.time()
+    if name not in self.cp:
+      self.cp[name] = 0.
+      if ignore:
+        self.cp_ignored.append(name)
+    self.cp[name] += tt - self.last_time
+    if not ignore:
+      self.tot += tt - self.last_time
+    self.last_time = tt
+
+  def display(self):
+    if not self.enabled:
+      return
+    self.iter += 1
+    print("******* Profiling *******")
+    for n, ms in sorted(self.cp.items(), key=lambda x: -x[1]):
+      if n in self.cp_ignored:
+        print("%30s: %7.2f   percent: %3.0f   IGNORED" % (n, ms*1000.0, ms/self.tot*100))
+      else:
+        print("%30s: %7.2f   percent: %3.0f" % (n, ms*1000.0, ms/self.tot*100))
+    print("Iter clock: %2.6f   TOTAL: %2.2f" % (self.tot/self.iter, self.tot))
+

common/queue.h

@@ -1,52 +0,0 @@
-#pragma once
-
-#include <condition_variable>
-#include <mutex>
-#include <queue>
-
-template <class T>
-class SafeQueue {
-public:
-  SafeQueue() = default;
-
-  void push(const T& v) {
-    {
-      std::unique_lock lk(m);
-      q.push(v);
-    }
-    cv.notify_one();
-  }
-
-  T pop() {
-    std::unique_lock lk(m);
-    cv.wait(lk, [this] { return !q.empty(); });
-    T v = q.front();
-    q.pop();
-    return v;
-  }
-
-  bool try_pop(T& v, int timeout_ms = 0) {
-    std::unique_lock lk(m);
-    if (!cv.wait_for(lk, std::chrono::milliseconds(timeout_ms), [this] { return !q.empty(); })) {
-      return false;
-    }
-    v = q.front();
-    q.pop();
-    return true;
-  }
-
-  bool empty() const {
-    std::scoped_lock lk(m);
-    return q.empty();
-  }
-
-  size_t size() const {
-    std::scoped_lock lk(m);
-    return q.size();
-  }
-
-private:
-  mutable std::mutex m;
-  std::condition_variable cv;
-  std::queue<T> q;
-};

common/ratekeeper.cc

@@ -1,40 +0,0 @@
-#include "common/ratekeeper.h"
-
-#include <algorithm>
-
-#include "common/swaglog.h"
-#include "common/timing.h"
-#include "common/util.h"
-
-RateKeeper::RateKeeper(const std::string &name_, float rate, float print_delay_threshold_)
-    : name(name_),
-      print_delay_threshold(std::max(0.f, print_delay_threshold_)) {
-  interval = 1 / rate;
-  last_monitor_time = seconds_since_boot();
-  next_frame_time = last_monitor_time + interval;
-}
-
-bool RateKeeper::keepTime() {
-  bool lagged = monitorTime();
-  if (remaining_ > 0) {
-    util::sleep_for(remaining_ * 1000);
-  }
-  return lagged;
-}
-
-bool RateKeeper::monitorTime() {
-  ++frame_;
-  last_monitor_time = seconds_since_boot();
-  remaining_ = next_frame_time - last_monitor_time;
-
-  bool lagged = remaining_ < 0;
-  if (lagged) {
-    if (print_delay_threshold > 0 && remaining_ < -print_delay_threshold) {
-      LOGW("%s lagging by %.2f ms", name.c_str(), -remaining_ * 1000);
-    }
-    next_frame_time = last_monitor_time + interval;
-  } else {
-    next_frame_time += interval;
-  }
-  return lagged;
-}