Metadata-Version: 2.1
Name: matrixorbital-vfd
Version: 0.1.1
Summary: I2C display driver for Matrix Orbital VFDs
Home-page: https://github.com/derekn/matrixorbital-vfd
Author: Derek Nicol
Author-email: derekn85@gmail.com
License: MIT
Keywords: matrix orbital vfd vacuum fluorescent display i2c smbus
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: Topic :: Utilities
Requires-Python: >=3.4.0
Description-Content-Type: text/markdown
License-File: LICENSE

# MatrixOrbital-VFD

I2C display driver for Matrix Orbital VFDs.

_unofficial, not affiliated with [Matrix Orbital Corp](https://www.matrixorbital.com/)_

### Install

```shell
pip install matrixorbital-vfd
```

### Usage

```python
from matrixorbital_vfd import VFD, Brightness

with VFD(1, 0x2e) as vfd:
	vfd.clear()
	vfd.brightness(Brightness.HIGH)
	vfd.write('Hello, world!')
```

### Functions

- `VFD.display(True/False)`  
  turn on/off display

- `VFD.home()`  
  move cursor to home position 0x0

- `VFD.position(column, row)`  
  move cursor to specified column/row position

- `VFD.move('left'/'right')`  
  move cursor left/right 1 column

- `VFD.clear()`  
  clear screen

- `VFD.brightness(Brightness.MEDIUM or 'MEDIUM')`  
  set brightness to specified level

- `VFD.cursor(True/False)`  
  enable/disable block (blinking) cursor

- `VFD.wrap(True/False)`  
  enable/disable line wrapping

- `VFD.scroll(True/False)`  
  enable/disable auto line scrolling

- `VFD.write('text')`  
  write text to display


