Initial documentation pages
This commit is contained in:
commit
a7eb35bc5a
3 changed files with 37 additions and 0 deletions
31
README.md
Normal file
31
README.md
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
# OpenRCore
|
||||||
|
|
||||||
|
OpenRCore ("Open Robot Core") is an open source project intended to provide a
|
||||||
|
similar development experience as FIRST Tech Challenge's [FtcRobotController](https://github.com/FIRST-Tech-Challenge/FtcRobotController)
|
||||||
|
but supporting more affordable hardware.
|
||||||
|
|
||||||
|
## Hardware Overview
|
||||||
|
|
||||||
|
OpenRCore targets the [nRF52 devkit](https://www.nordicsemi.com/Products/Development-hardware/nRF52-DK),
|
||||||
|
rather than the REV control hub. This hardware was chosen for a few reasons:
|
||||||
|
|
||||||
|
- Cost & Availability: The nRF52 devkit is available from multiple vendors, and
|
||||||
|
runs for less than $40 USD.
|
||||||
|
- Integrated Bluetooth: The devkit comes with built-in Bluetooth, which is used
|
||||||
|
for connecting via a server control application.
|
||||||
|
- Zephyr: The devkit is intended to be used with Zephyr (what this project is
|
||||||
|
using), and is a great introduction into embedded development.
|
||||||
|
- Arduino Shield Compatible: The devkit has the same pin-out as an Arduino, so
|
||||||
|
the project can be extended to support a variety of shield peripherals.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
TBD
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
TBD
|
||||||
|
|
||||||
|
## Design
|
||||||
|
|
||||||
|
For information on how OpenRCore is designed, refer to the [design documentation](docs/design.md).
|
||||||
6
docs/design.md
Normal file
6
docs/design.md
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
# OpenRCore Design
|
||||||
|
|
||||||
|
The following diagram provides a high level overview of how OpenRCore and a
|
||||||
|
connected control server would interact:
|
||||||
|
|
||||||
|

|
||||||
BIN
docs/openrcore_overview.png
Normal file
BIN
docs/openrcore_overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
Loading…
Reference in a new issue