Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
makermelissa Merge pull request #29 from dherrada/master
Added module name to beginning of example filenames & updated docs to match
Latest commit b39acdb May 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_espatcontrol fixes per review Feb 27, 2019
docs Updated docs to reflect changes May 10, 2019
examples Updated example filenames May 10, 2019
.gitignore PyPI setup. Dec 19, 2018
.pylintrc cookie Dec 16, 2018
.readthedocs.yml cookie Dec 16, 2018
.travis.yml lint all! Jan 16, 2019
CODE_OF_CONDUCT.md cookie Dec 16, 2018
LICENSE cookie Dec 16, 2018
README.rst PyPI setup. Dec 19, 2018
requirements.txt cookie Dec 16, 2018
setup.py now in a package Jan 16, 2019

README.rst

Introduction

Documentation Status Discord Build Status

Use the ESP AT command sent to communicate with the Interwebs. Its slow, but works to get data into CircuitPython

Command set: https://www.espressif.com/sites/default/files/documentation/4a-esp8266_at_instruction_set_en.pdf

Examples: https://www.espressif.com/sites/default/files/documentation/4b-esp8266_at_command_examples_en.pdf

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-esp-atcontrol

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-esp-atcontrol

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-esp-atcontrol

Usage Example

See examples folder for full demos

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-espatcontrol --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.