# cordova-plugin-esptouch

> cordova plugin esptouch v2 for esp8266 and esp32

Latest version **2.0.0** (published 2022-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install cordova-plugin-esptouch
pnpm add cordova-plugin-esptouch
yarn add cordova-plugin-esptouch
bun add cordova-plugin-esptouch
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2022-08-14 |
| First published | 2017-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Author | coloz |
| Maintainers | coloz |
| Keywords | ecosystem:cordova, esptouch, esptouch-v2, cordova-android, cordova-ios |

## Links

- npm: https://www.npmjs.com/package/cordova-plugin-esptouch
- Repository: https://github.com/coloz/cordova-plugin-esptouch
- Homepage: https://github.com/coloz/cordova-plugin-esptouch#readme
- Issues: https://github.com/coloz/cordova-plugin-esptouch/issues
- npm.io page: https://npm.io/package/cordova-plugin-esptouch

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2022-08-14
- 1.0.9 — 2020-12-15
- 1.0.8 — 2020-03-21
- 1.0.7 — 2019-03-28
- 1.0.6 — 2019-03-14
- 1.0.5 — 2019-03-06
- 1.0.4 — 2018-10-20
- 1.0.3 — 2018-02-09
- 1.0.2 — 2018-02-09
- 1.0.1 — 2017-11-13
- 1.0.0 — 2017-11-12

## README

# cordova-plugin-esptouch 2.0

配合esp8266、esp32进行esptouch配网的cordova插件，集成了esptouch V1、V2, 并提供配网时必要的wifi检查功能，可用于ionic、cordova项目。  
  
## 支持平台  
ios 12.x  
android 5+  

## 参考引用  
https://github.com/EspressifApp/EsptouchForAndroid  
https://github.com/EspressifApp/lib-esptouch-v2-android  
https://github.com/EspressifApp/EsptouchForIOS  
https://github.com/EspressifApp/EsptouchForIOS/tree/master/EspTouchDemo/ESPTouchV2  

## 使用方法  
### 安装  
```
cordova plugin add cordova-plugin-esptouch
```

### 使用方法 
#### WiFi相关检查  
```javascript
declare var wifi;

wifi.checkLocation( 
  result => { 
    if(!result) console.log('未开启位置服务')
  }
);

wifi.getConnectedInfo(
  result => { 
    console.log(result)
    /*
    {
      ip:'192.186.1.111'  // 这里不知道为啥多了个/，自己处理下
      is5G: false
      ssid: 'test'
      bssid:'00:00:00:00:00:00'
      state:'Connected'
    }
    */
    if(result.is5G) console.log('当前设备仅支持2.4G热点接入，请更换热点')
  }, 
  error => { 
    console.log(error) 
    if(error.state=='NotConnected') console.log('WiFi未连接');
    else if(error.state=='Connecting') console.log('WiFi连接中');
  }
)

```
#### esptouch v2
```javascript
declare var esptouch2;

esptouch2.start(ssid, password, customData, 
  result => { console.log(result) }, 
  error => { console.log(error) }
}

esptouch2.stop(
  result => { console.log(result) }, // {"bssid":"ffffffffffff","ip":"192.168.1.123"}
  error => { console.log(error) }
);

```
#### esptouch v1
```javascript
declare var esptouch;

esptouch.start(ssid, password, 
  result => { console.log(result) }, 
  error => { console.log(error) }
}

esptouch.stop(
  result => { console.log(result) }, // {"bssid":"ffffffffffff","ip":"192.168.1.123"}
  error => { console.log(error) }
);
```


### 输出  
```json
{"bssid":"ffffffffffff","ip":"192.168.1.123"}
```

## 网络乞讨  
如果你觉得该项目不错，可以打个star支持下  

## 技术支持  
提供cordova/ionic开发、ESP8266/ESP32开发技术支持服务，300元/每小时  
联系邮箱：clz@clz.me

---
_Source: https://npm.io/package/cordova-plugin-esptouch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._