libhal-esp8266

libhal device library for the esp8266 wifi module/soc from espressif.

📚 Software APIs & Usage

To learn about the available drivers and APIs see the Doxygen documentation page or look at the include/libhal-esp8266 directory.

To see how each driver is used see the demos/ directory.

🧰 Setup

Following the 🚀 Getting Started instructions.

📡 Installing Profiles

The libhal-lpc40 profiles used for demos. To install them use the following commands.

conan config install -sf conan/profiles/ -tf profiles https://github.com/libhal/libhal-armcortex.git
conan config install -sf conan/profiles/ -tf profiles https://github.com/libhal/libhal-lpc40.git

🏗️ Building Demos

To build demos, start at the root of the repo and execute the following command:

conan build demos -pr lpc4078 -s build_type=Debug

or for the lpc4074

conan build demos -pr lpc4074 -s build_type=Debug

📦 Adding libhal-esp8266 to your project

Add the following to your requirements() method:

    def requirements(self):
        self.requires("libhal-esp8266/[^2.0.0]")

🔌 Device Wiring & Hookup guide (ESP-01 variant)

1. Locate the TX (UART Transmit Data) and RX (UART Receive Data) pins on your microcontroller port.
2. Connect the microcontroller's TX pin to the RX pin of the ESP-01 pin.
3. Connect the microcontroller's RX pin to the TX pin of the ESP-01 pin.
4. Supply adequate power to the ESP-01 with 3v3 at the VCC line.

⬆️ Upgrading esp-01 firmware

Install esptool.py:

pip install esptool

Change into the third_party/2.2.0 directory and flash the esp-01 using the following command:

esptool.py -p /dev/tty.usbserial-210 -b 115200 write_flash -e @download.config

Replace /dev/tty.usbserial-210 with the correct TTY or COM port device.

If version 2.2.0 does not work, then try 1.7.5. The flashing command is the same.

Contributing

See CONTRIBUTING.md for details.

License

Apache 2.0; see LICENSE for details.

Disclaimer

This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.