Introduction
CircuitPython helper library for displayio layouts and widgets.
Dependencies
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
Installing from PyPI
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-displayio-layout
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-displayio-layout
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-displayio-layout
Usage Example
See scripts in the examples directory of this repository.
Documentation
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributing
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Table of Contents
Examples
- Simple test
- Cartesian plane simple test
- Cartesian lineplot
- Cartesian Advanced
- GridLayout simple text
- GridLayout divider lines example
- GridLayout Get Cell
- Pygame simple test
- Icon Animated simple test
- Page Layout simple test
- Page Layout advanced test
- Pygame Switch example
- Switch simple test
- Switch test with multiple switches
- FlipInput simple test
- Tab Layout simple test
- Tab Layout touch test
API Reference
grid_layoutGridLayoutpage_layoutPageLayouttab_layoutTabLayoutwidgetWidgetcontrolControlswitch_roundSwitchRoundSwitchRound.selected()SwitchRound.contains()SwitchRound.valueSwitchRound.widthSwitchRound.heightSwitchRound.anchor_pointSwitchRound.anchored_positionSwitchRound.append()SwitchRound.bounding_boxSwitchRound.hiddenSwitchRound.index()SwitchRound.insert()SwitchRound.pop()SwitchRound.remove()SwitchRound.resize()SwitchRound.scaleSwitchRound.sort()SwitchRound.xSwitchRound.y
icon_widgetIconWidgeticon_animatedIconAnimatedflip_inputFlipInputcartesianCartesianCartesian.update_pointer()Cartesian.add_plot_line()Cartesian.anchor_pointCartesian.anchored_positionCartesian.append()Cartesian.bounding_boxCartesian.heightCartesian.hiddenCartesian.index()Cartesian.insert()Cartesian.pop()Cartesian.remove()Cartesian.resize()Cartesian.scaleCartesian.sort()Cartesian.widthCartesian.xCartesian.yCartesian.clear_plot_lines()
Tutorials