# react-native-esp-idf

> ESP IDF Provisioning

Latest version **0.4.0** (published 2021-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-esp-idf
pnpm add react-native-esp-idf
yarn add react-native-esp-idf
bun add react-native-esp-idf
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2021-12-20 |
| First published | 2021-06-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 727.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jian Zhang |
| Maintainers | dsonet |
| Keywords | react-native, ios, android |

## Links

- npm: https://www.npmjs.com/package/react-native-esp-idf
- Repository: https://github.com/HF-LINQ-Mobile/ESP-IDF-RN
- Homepage: https://github.com/HF-LINQ-Mobile/ESP-IDF-RN#readme
- Issues: https://github.com/HF-LINQ-Mobile/ESP-IDF-RN/issues
- npm.io page: https://npm.io/package/react-native-esp-idf

## 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

- 0.4.0 (latest) — 2021-12-20
- 0.3.6 — 2021-08-20
- 0.3.5 — 2021-08-20
- 0.3.4 — 2021-08-19
- 0.3.3 — 2021-08-18
- 0.3.2 — 2021-08-16
- 0.3.1 — 2021-06-03
- 0.3.0 — 2021-06-03
- 0.2.0 — 2021-06-02

## README

# react-native-esp-idf

ESP IDF Provisioning

## Installation

```sh
npm install react-native-esp-idf
```

## Usage

```js
import EspIdfRn, { useProvisioning } from 'react-native-esp-idf';


// ...

const devicePrefix = 'PROV_'
	const message: MessageInfo = {
		scanBle: 'Searching device...',
		waitingCertificate: 'Waiting for certificates...',
		scanWifi: 'Searching available Wi-Fi...',
		connectDevice: 'Connecting your device...',
		sendingWifiCredential: 'Sending Wi-Fi credentials',
		confirmWifiConnection: 'Confirming Wi-Fi connection',
		enableBluetooth: 'Please enable the Bluetooth to start scan device.',
		enableLocation:
			'Please grant location permission to start scan device.',
		scanBleFailed: 'Scan device failed, please try again.',
		connectFailed: 'Connect to device failed, please try again.',
		disconnected: 'device disconnected, please try again.',
		initSessionError: 'Reboot your device and retry.',
		applyError: 'Reset your device and retry.',
		completed: 'Device has been successfully provisioned!',
	}
	const {
		bleDevices,
		wifiAPs,
		loading,
		status,
		currentStep,
		currentWifi,
		currentDevice,
		results,
		setCurrentStep,
		configWifi,
		connectDevice,
		doProvisioning,
		sendCertificate,
	} = useProvisioning({ devicePrefix, message, pop: 'abcd1234' })
```

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT

---
_Source: https://npm.io/package/react-native-esp-idf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._