/hmPy

Python library for creating native human machine interfaces

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

hmPy

travis docs pypi

Purpose

hmPy is a Python library for building HMIs.

Installing hmPy

To install the latest version of hmPy using pip:

$ pip install hmPy

Running Tests

hmPy's test suite can be run using tox:

$ tox

Note that pep8 compliance is required for the tests to pass.

Example Code

For those of you who want to hit the ground running:

from hmpy import Interface
from hmpy.views import ButtonView, LCDView

# Create the base interface
hmi = Interface()

# Initialize counter to 0
count = 0

# Initialize an LCD View and a button View
lcd = LCDView()
btn = ButtonView("Increment")

def increment_count():
    lcd.value += 1

# Call the increment count method whenever the button is pressed
btn.on_press(increment_count)

# Add the views to the interface
hmi.add_view(lcd)
hmi.add_view(btn)

# Launch the interface
hmi.start()

For more detailed documentation and advanced examples, see the full documentation.

Documentation

Full documentation and tutorial available at Read the Docs.