Skip to content

Commit

Permalink
Update getting started.
Browse files Browse the repository at this point in the history
  • Loading branch information
bakercp committed Jul 25, 2019
1 parent a5b3826 commit 1c95fa2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

First, it might be worth it to read the [background introduction](BACKGROUND.md).

## Installation

This project can be installed using the Arduino IDE. Navigate to the _Tools > Manage Libraries ..._ menu item and search for `PacketSerial`.

Alternatively, this library can be downloaded or cloned from github and to your Arduino `libraries` folder.

## Use

`PacketSerial` class wraps the Arduino `Stream` class to automatically encode and decode byte packets that are sent and received. Typically serial communication uses the default `Serial` object, which implements the `Stream` class. In most cases, `PacketSerial` should be given exclusive access to the serial `Stream` (e.g. for a default setup using `Serial`, users should avoid calling functions like `Serial.print()`, `Serial.write()`, etc directly). Data should be sent via the `send(const uint8_t* buffer, size_t size) const` method and received in a `PacketSerial` callback function (see below).
Expand Down

0 comments on commit 1c95fa2

Please sign in to comment.