https://github.com/vinicentus/rpi_serial
rpi_serial is a Dart package for using serial communication on the Raspberry Pi.
https://github.com/vinicentus/rpi_serial
dart gpio raspberry-pi serial
Last synced: 4 months ago
JSON representation
rpi_serial is a Dart package for using serial communication on the Raspberry Pi.
- Host: GitHub
- URL: https://github.com/vinicentus/rpi_serial
- Owner: vinicentus
- License: other
- Created: 2019-06-29T12:03:16.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-29T12:04:12.000Z (about 7 years ago)
- Last Synced: 2025-10-23T03:33:43.540Z (8 months ago)
- Topics: dart, gpio, raspberry-pi, serial
- Language: Dart
- Size: 65.4 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# rpi_serial
rpi_serial is a Dart package for using serial communication on the Raspberry Pi.
## Overview
* The [__Serial__](lib/serial.dart) library provides the API for accessing devices
using the [serial protocol](https://en.wikipedia.org/wiki/Serial_communication)
* The [__RpiSerial__](lib/rpi_serial.dart) library provides implementation of
the serial protocol on the Raspberry Pi derived from the [WiringPi](http://wiringpi.com/) library.
## Setup
Be sure to enable serial on the Raspberry Pi using
```shell
sudo raspi-config
```
Also make sure to disable the console on the serial port.
[__RpiSerial__](lib/rpi_serial.dart) uses a native library written in C.
For security reasons, authors cannot publish binary content
to [pub.dev](https://pub.dev/), so there are some extra
steps necessary to compile the native library on the RPi before this package
can be used. These two steps must be performed when you install and each time
you upgrade the rpi_serial package.
1. Activate the rpi_serial package using the
[pub global](https://dart.dev/tools/pub/cmd/pub-global) command.
```dart
pub global activate rpi_serial
```
2. From your application directory (the application that references
the rpi_serial package) run the following command to build the native library
```dart
pub global run rpi_serial:build_lib
```
3. Deactivate the rpi_serial package.
```dart
pub global deactivate rpi_serial
```
[pub global activate](https://dart.dev/tools/pub/cmd/pub-global#activating-a-package)
makes the Dart scripts in the rpi_serial/bin directory runnable
from the command line.
[pub global run](https://dart.dev/tools/pub/cmd/pub-global#running-a-script)
rpi_serial:build_lib runs the [rpi_serial/bin/build_lib.dart](bin/build_lib.dart)
program which in turn calls the [build_lib](lib/src/native/build_lib) script
to compile the native librpi_serial_ext.so library for the rpi_serial package.
## Connecting
Refer to [Raspberry Pi GPIO](https://www.raspberrypi.org/documentation/usage/gpio/) for connecting your serial device to the Raspberry Pi.
By default pins 8 is TX and 10 is RX on the GPIO header.
Note that the Raspberry Pi actually has two UARTs.
On the versions with Bluetooth (Raspberry Pi 3 and Raspberry Pi Zero W), the UART exposed to the GPIO pins is __"/dev/ttyS0"__, while it is __"/dev/ttyAMA0"__ on the rest of the boards.
This can be changed (see [Rapsberry Pi UART configuration](https://www.raspberrypi.org/documentation/configuration/uart.md)).
On the compute module, you can supposedly expose both serial interfaces on the GPIO.
## Examples
[basic_device](example/basic_device.dart) is a class containing most of the basic features that you would need to comunicate with a serial device. This is implemented using the API ([__Serial__](lib/serial.dart)). No low-level interactions required. If you want to communicate with another device, you should probably create a similar class, but specific to that device.
[example](example/example.dart) is for demonstrating basic read and write operations using the [basic_device](example/basic_device.dart) class.
Hopefully the examples are pretty self-explanatory.