mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-10-03 18:09:02 -04:00
87 lines
2.5 KiB
Markdown
87 lines
2.5 KiB
Markdown
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
|
[](https://github.com/RobTillaart/PAR27979/actions/workflows/arduino-lint.yml)
|
|
[](https://github.com/RobTillaart/PAR27979/actions/workflows/jsoncheck.yml)
|
|
[](https://github.com/RobTillaart/PAR27979/blob/master/LICENSE)
|
|
[](https://github.com/RobTillaart/PAR27979/releases)
|
|
|
|
|
|
# PAR27979
|
|
|
|
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.
|
|
|
|
Should work for 27976 and 27977 display although not tested.
|
|
|
|
|
|
## Interface
|
|
|
|
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
|
|
methods to make working with it easier.
|
|
|
|
|
|
### Base
|
|
|
|
- **PAR27979(Stream \* str)** constructor, used stream as parameter.
|
|
- **void on()** switch display on.
|
|
- **void off()** switch display off.
|
|
- **void clearHome()** clear the display.
|
|
- **void backlightOn()** enable the backlight.
|
|
- **void backLightOff()** disable the backlight.
|
|
|
|
|
|
### Cursor Movement
|
|
|
|
- **void left()** move cursor.
|
|
- **void right()** move cursor.
|
|
- **void down()** move cursor.
|
|
- **void gotoXY(uint8_t x, uint8_t y)** idem.
|
|
|
|
|
|
### Custom chars
|
|
|
|
see datasheet.
|
|
|
|
- **void defineCustomChar(uint8_t idx, uint8_t \* arr)** array will need to be 8 bytes.
|
|
- **void customChar(uint8_t idx)** idem.
|
|
|
|
|
|
### Sound support
|
|
|
|
- **void octave(uint8_t octave)** octave = 3 4 5 6 7
|
|
- **void duration(uint8_t duration)** duration = 1 2 4 8 16 32 64
|
|
- **void play(uint8_t note)** note = 0 1 2 3 4 5 6 7 8 9 10 11 0=A 1=A# etc.
|
|
- **void noSound()** idem.
|
|
|
|
|
|
## Support Parallax 27976 & 27977
|
|
|
|
Although not tested, the functions should work with the
|
|
Parallax 27976 and 27977 displays too.
|
|
|
|
|
|
## Operation
|
|
|
|
See examples.
|
|
|
|
## Future
|
|
|
|
only extend on a per request basis
|
|
|
|
- documentation
|
|
- different baud rates?
|
|
- test custom chars
|
|
- more testing.
|
|
- test 27976 and 27977 display
|
|
- extend unit test
|
|
|