diff --git a/docs/concepts/glossary.md b/docs/concepts/glossary.md new file mode 100644 index 0000000000..46e8e834d2 --- /dev/null +++ b/docs/concepts/glossary.md @@ -0,0 +1,8 @@ +# openpilot glossary + +* **route**: +* **segment**: routes are split into one minute chunks called segments. +* **panda**: this is . See the repo. +* **onroad**: +* **offroad**: +* **comma 3X**: diff --git a/system/loggerd/README.md b/docs/concepts/logs.md similarity index 86% rename from system/loggerd/README.md rename to docs/concepts/logs.md index 714e4242a0..46ab2897df 100644 --- a/system/loggerd/README.md +++ b/docs/concepts/logs.md @@ -1,10 +1,8 @@ -# loggerd +# Logging openpilot records routes in one minute chunks called segments. A route starts on the rising edge of ignition and ends on the falling edge. -Check out our [python library](https://github.com/commaai/openpilot/blob/master/tools/lib/logreader.py) for reading openpilot logs. Also checkout our [tools](https://github.com/commaai/openpilot/tree/master/tools) to replay and view your data. These are the same tools we use to debug and develop openpilot. - -## log types +Check out our [Python library](https://github.com/commaai/openpilot/blob/master/tools/lib/logreader.py) for reading openpilot logs. Also checkout our [tools](https://github.com/commaai/openpilot/tree/master/tools) to replay and view your data. These are the same tools we use to debug and develop openpilot. For each segment, openpilot records the following log types: @@ -15,9 +13,10 @@ rlogs contain all the messages passed amongst openpilot's processes. See [cereal ## {f,e,d}camera.hevc Each camera stream is H.265 encoded and written to its respective file. -* fcamera.hevc is the road camera -* ecamera.hevc is the wide road camera -* dcamera.hevc is the driver camera + +* `fcamera.hevc` is the road camera +* `ecamera.hevc` is the wide road camera +* `dcamera.hevc` is the driver camera ## qlog.bz2 & qcamera.ts diff --git a/docs/concepts/safety.md b/docs/concepts/safety.md new file mode 120000 index 0000000000..f286ad4b15 --- /dev/null +++ b/docs/concepts/safety.md @@ -0,0 +1 @@ +../SAFETY.md \ No newline at end of file diff --git a/docs/how-to/replay-a-drive.md b/docs/how-to/replay-a-drive.md new file mode 100644 index 0000000000..084b6bf825 --- /dev/null +++ b/docs/how-to/replay-a-drive.md @@ -0,0 +1,14 @@ +# Replay + +Replaying is a critical tool for openpilot development and debugging. + +## Replaying a route +*Hardware required: none* + +Just run `tools/replay/replay --demo`. + +## Replaying CAN data +*Hardware required: jungle and comma 3/3X* + +1. Connect your PC to a jungle. +2. diff --git a/mkdocs.yml b/mkdocs.yml index b9a901c4d7..8778e28863 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -16,6 +16,10 @@ nav: - How-to: - Turn the speed blue: how-to/turn-the-speed-blue.md - Connect to a comma 3/3X: how-to/connect-to-comma.md + #- Replay a drive: how-to/replay-a-drive.md + - Concepts: + - Logs: concepts/logs.md + - Safety: concepts/safety.md - Car Porting: - What is a car port?: car-porting/what-is-a-car-port.md - Porting a car brand: car-porting/brand-port.md