Skip to content

Commit

Permalink
Tweak readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sarfata committed Nov 17, 2015
1 parent 00af6a0 commit d78b526
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,11 @@ This library provides a Teensy driver for the NMEA2000 library.

See https://github.com/ttlappalainen/NMEA2000.

## Hardware

This only works with Teensy 3.1/3.2.

You will need a CAN transceiver like the MCP2551.

Teensy MCP2551 NMEA2000 Cable
## Usage

TX -> TxD
RX -> RxD
CANH Blue
CANL White
Gnd Gnd Gnd
Vin (5v when usb) VDD
Gnd Rs
Vref (disconnected)
This library requires the [FlexCAN](https://github.com/teachop/FlexCAN_Library). Make sure you have it installed.

## Usage

#include <NMEA2000.h>
#include <N2kMessages.h>
Expand All @@ -38,6 +25,23 @@ You will need a CAN transceiver like the MCP2551.

See the [NMEA2000](https://github.com/ttlappalainen/NMEA2000) for more examples. They are all compatible with this library.

## Hardware

This driver only works with Teensy 3.1/3.2.

You will need a CAN transceiver like the MCP2551 (for a list of other tested CAN controllers, refer to the [FlexCAN library README](https://github.com/teachop/FlexCAN_Library).

| Teensy | MCP2551 | NMEA2000 Cable |
| ----------------- | ------------------- | -------------- |
| TX | TxD | |
| RX | RxD | |
| | CANH | Blue |
| | CANL | White |
| Gnd | Gnd | Black |
| Vin (5v when usb) | VDD | |
| Gnd | Rs | |
| | Vref (disconnected) | |

## License

2015 Copyright (c) Thomas Sarlandie. All right reserved.
Expand Down

0 comments on commit d78b526

Please sign in to comment.