GY-63_MS5611/libraries/optoma/README.md

53 lines
1.5 KiB
Markdown
Raw Normal View History

2021-01-29 06:31:58 -05:00
[![Arduino CI](https://github.com/RobTillaart/Optoma/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/Optoma/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/Optoma.svg?maxAge=3600)](https://github.com/RobTillaart/Optoma/releases)
# Optoma
Arduino library to control Optoma W305ST beamer over RS232.
## Description
The Optoma library contains functions that help to control
the beamer from an Arduino.
The library is tested with an UNO and an Optoma W305ST Beamer.
The commands can work on other Optoma Beamers
Command structure
```
~XXnnn parameter
~ start command
XX 2 digit ID
nnn command can be up to 3 char/digit
space space
param parameters, depend on command
\r end command
```
## Interface
The following functions are implemented:
- **Optoma(HardwareSerial = Serial)** constructor, default uses Serial,
other HW or SW Serial are possible.
- **init(ID, baudrate)** default baudrate = 9600.
The ID is used to address a specific beamer.
In theory one could have multiple beamers on one RS232 port (never seen or tested)
- **switchOn()** idem
- **switchOff()** idem
- **increaseVKS()** VKS - Vertical KeyStone
- **decreaseVKS()** VKS - Vertical KeyStone
## Future
- More functionality will be added on a need to basis.
- Create examples.
## Operation
Straightforward