Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SillyFreak committed Oct 5, 2019
1 parent 0f6cfec commit d99a47b
Show file tree
Hide file tree
Showing 5 changed files with 254 additions and 236 deletions.
4 changes: 2 additions & 2 deletions docs/source/architecture.rst
Expand Up @@ -14,7 +14,7 @@ Hardware Controller

The HWC is responsible for

- providing a steady power supply from a 6V-19V power source;
- providing a steady power supply from a 6V-24V power source;
- controlling servos and motors;
- connecting analog and digital sensors with optional pullup/pulldown resistors;
- providing additional connectors for serial buses, such as SPI;
Expand All @@ -36,7 +36,7 @@ Of course, keyboard, mouse and monitor can also be directly connected via USB an
The SWC runs Raspbian as its operating system, and hosts the Hedgehog Server and Hedgehog Web IDE.
Hedgehog Server acts as an intermediary between client programs and the HWC.
It makes sure that all clients can access the hardware correctly, even if there are multiple clients,
and allows clients to connect bot locally and over the network using the Hedgehog Protocol.
and allows clients to connect both locally and over the network using the Hedgehog Protocol.

The Hedgehog Web IDE is a web application that is hosted on the controller, meaning that an internet connection is not required for using Hedgehog.
Yet, using a browser-based development environment means that no installation is required and multiple operating systems can be supported with ease.
Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Expand Up @@ -19,16 +19,16 @@ Its most important features and properties are as follows:
- control your Hedgehog locally or over the network
- protocol stack designed for reliability
- easy to implement in many popular programming languages
- few assumptions to allow for various approaches in programming interfaces
- few assumptions to allow for diverse programming interfaces
- versatile application programming interfaces (APIs)
- visual programming via Blockly
- textual programming mainly via Python, but node.js and Java already supported as well
- textual programming mainly via Python, but node.js already supported as well
- simple, yet not limiting
- made for tinkering and hacking
- compatible with RC servos & DC motors, various analog and digital sensors
- controller case can be mounted to Lego models
- hardware blueprints (case & circuit boards) available for modification
- CAD software, microcontroller toolchain, git, ... pre-installed on the controller
- microcontroller toolchain, git, ... pre-installed on the controller
- classroom ready
- One WiFi for all controllers avoids network congestion
- many educational use cases, appropriate for various ages
Expand Down

0 comments on commit d99a47b

Please sign in to comment.