GY-63_MS5611/libraries/Par27979/readme.md

61 lines
1.7 KiB
Markdown
Raw Normal View History

2021-01-29 06:31:58 -05:00
[![Arduino CI](https://github.com/RobTillaart/PAR27979/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/PAR27979/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/PAR27979.svg?maxAge=3600)](https://github.com/RobTillaart/PAR27979/releases)
2020-11-27 05:28:57 -05:00
# PAR27979
2013-09-30 12:12:19 -04:00
2020-11-27 05:28:57 -05:00
Arduino library for the Parallax 27979 serial display
## Description
The library is essentially a wrapper around a Stream, typically Serial,
Serial2 (3,4..) or newSoftSerial or equivalent.
This stream is given as parameter in the constructor.
2021-01-29 06:31:58 -05:00
## Interface
2020-11-27 05:28:57 -05:00
The library implements the **Print** interface to print integers
floats and strings and all printable types.
The library does not keep any state information, it only implements a few
2021-01-29 06:31:58 -05:00
methods to make working with it easier.
### Base
- **PAR27979(Stream \* str)** constructor, used stream as parameter.
- **on()** switch display on
- **off()** switch display off
- **clearHome()** clear the display
- **backlightOn()** enable the backlight
- **backLightOff()** disable the backlight
### Cursor Movement
- **cursorLeft()** move cursor
- **cursorRight()** move cursor
- **lineFeed()** idem
- **formFeed()** idem
- **gotoXY(x, y)**
### Sound support
- **octave(octave)** octave = 3 4 5 6 7
- **duration(duration)** duration = 1 2 4 8 16 32 64
- **play(note)** note = 0 1 2 3 4 5 6 7 8 9 10 11 0=A 1=A# etc
- **noSound()**
2020-11-27 05:28:57 -05:00
## Support Parallax 27976 & 27977
Although not tested, the functions should work with the
Parallax 27976 and 27977 displays too.
2021-01-29 06:31:58 -05:00
## Todo
- baudrate?
2020-11-27 05:28:57 -05:00
## Operation
See example