https://github.com/niklauslee/esp8266-http-client
A simple Kaluma HTTP client library for ESP8266 module
https://github.com/niklauslee/esp8266-http-client
esp8266 http kaluma
Last synced: 11 months ago
JSON representation
A simple Kaluma HTTP client library for ESP8266 module
- Host: GitHub
- URL: https://github.com/niklauslee/esp8266-http-client
- Owner: niklauslee
- License: mit
- Created: 2022-02-17T04:09:35.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-17T04:58:19.000Z (almost 4 years ago)
- Last Synced: 2025-01-21T17:30:36.182Z (about 1 year ago)
- Topics: esp8266, http, kaluma
- Language: JavaScript
- Homepage:
- Size: 63.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESP8266 HTTP Client
A simple Kaluma HTTP client library for ESP8266 module. It includes minimum code just to send a HTTP request using AT command.
Tested firmware versions:
| Module | Manufacturer | AT version | SDK version |
| ------ | ------------ | ---------- | ----------- |
| ESP-01 | Ai-Thinker Technology Co. Ltd. | 1.2.0.0 | 1.5.4.1 |
# Wiring
Here is a wiring example for `UART0`.
| Raspberry Pi Pico | ESP8266 |
| ----------------- | ---------- |
| 3V3 | VCC, CH_PD |
| GND | GND |
| GP0 (UART0 TX) | RXD |
| GP1 (UART0 RX) | TXD |
# Install
```sh
npm install https://github.com/niklauslee/esp8266-http-client
```
# Usage
```js
const {ESP8266HTTPClient} = require('esp8266-http-client');
const esp = new ESP8266HTTPClient(null, {debug: true});
esp.wifi()
.then(() => {
esp.http('http://your-server.com')
.then(res => {
console.log(res);
})
.catch(err => {
console.log(err);
});
})
.catch(err => {
console.log(err);
});
```
Or, you can use async function.
```js
async function main() {
try {
await esp.wifi();
const res = await esp.http('http://your-server.com');
} catch (err) {
console.log(err);
}
}
main();
```
# API
## Class: ESP8266HTTPClient
### new ESP8266HTTPClient([serial[, options]])
- `serial` `` UART object connected to ESP8266 module. Default: `board.uart(0)`.
- `options` `` Options for [ATCommand](https://docs.kaluma.io/api-reference/at-command).
### esp.wifi([connect])
- `connect` `` Wi-Fi connection info.
- `ssid` ``
- `password` ``
- Return: `>`
Connect to Wi-Fi network.
```js
esp.wifi({ssid:'MyHome', password:'12345678'})
.then(() => {
console.log('connected');
})
.catch(err => {
console.error(err);
});
```
If you do not want to expose your Wi-Fi connection info, you can set them in the storage. Add connection info manually in Terminal as below:
```
> storage.setItem('WIFI_SSID', 'MyHome');
> storage.setItem('WIFI_PASSWORD', '12345678');
```
If you have `WIFI_SSID` and `WIFI_PASSWORD` items in storage, then you can connect without connection info.
```js
esp.wifi()
.then(() => {
console.log('connected');
})
.catch(err => {
console.error(err);
});
```
### esp.http(url[, options])
- `url` `` URL.
- `options` ``
- `method` `` HTTP method.
- `headers` `` HTTP headers.
- `body` `` HTTP body.
- `timeout` ``. Maximum waiting time for HTTP response. Default: `10000` (10 sec).
- Returns: `>` Response object.
- `status` `` HTTP status code.
- `statusText` `` HTTP status text.
- `headers` `` HTTP response headers.
- `body` `` HTTP response body.
Send a HTTP request and returns the response.