https://github.com/andreock/capacitor-plugin-esptouch
A capacitor JS plugin to use ESPtouch V2 in your capacitor application.
https://github.com/andreock/capacitor-plugin-esptouch
Last synced: 3 months ago
JSON representation
A capacitor JS plugin to use ESPtouch V2 in your capacitor application.
- Host: GitHub
- URL: https://github.com/andreock/capacitor-plugin-esptouch
- Owner: andreock
- Created: 2023-07-25T15:31:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-25T15:31:57.000Z (almost 2 years ago)
- Last Synced: 2025-01-08T21:37:28.572Z (5 months ago)
- Language: CSS
- Size: 2.42 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# capacitor-plugin-esptouch
A capacitor JS plugin to use ESPtouch V2 in your capacitor application.
Only android is supported for the moment.
Check example for usage.
## Install
```bash
npm install capacitor-plugin-esptouch
npx cap sync
```
## API
* [`EsptouchV2(...)`](#esptouchv2)
* [Interfaces](#interfaces)
### EsptouchV2(...)
```typescript
EsptouchV2(options: EsptouchV2Request) => Promise
```
| Param | Type |
| ------------- | --------------------------------------------------------------- |
| **`options`** | EsptouchV2Request |
**Returns:** Promise<EsptouchV2Response>
--------------------
### Interfaces
#### EsptouchV2Response
| Prop | Type |
| -------------- | ------------------- |
| **`response`** | string |
| **`error`** | string |
#### EsptouchV2Request
| Prop | Type |
| ----------------- | ------------------- |
| **`ssid`** | string |
| **`bssid`** | string |
| **`password`** | string |
| **`custom_data`** | string |