-lorenzovecchi-react-native-esptouch-2-forked

中文文档
0.2.0发布于 2023/09/15MITTypeScriptESM + CJS零依赖

用于配置ESP设备连接到目标AP分叉版本

中文使用文档
文档目录6 节
  1. 安装
  2. 安卓
  3. iOS
  4. 使用
  5. 贡献
  6. 许可证

react-native-esptouch-2

我fork了这个repo来编辑由https://www.npmjs.com/package/@lorenzovecchi/react-native-esptouch-2/v/0.1.4创建的react-native-esptouch-2包

用于配置ESP设备连接到目标AP。

  • 同时支持安卓和iOS
  • iOS代码未经测试

这是一个非官方项目。官方演示如下:

EsptouchForAndroid

EsptouchForIOS

安装

从npm安装该模块

npm install @lorenzovecchi/react-native-esptouch-2

安卓

在AndroidManifest.xml中添加权限

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />

iOS

cd ios && pod install

使用

import * as ESPTouch2 from "react-native-esptouch-2";

/**
* Start the configuration broadcasting the informations to the device
* @param {string} ssid
*   AP SSID
* @param {string} bssid
*   AP BSSID
* @param {string} password
*   AP Password (null if open network)
* @param {string} customData
*   Additional data to send (nullable)
* @param {string} aesKey
*   Encrypt the data to send (if not null, it must be 16 byte) (nullable)
*
* @resolve {object} res
*   Object containing the successfully configured device address and bssid
* @reject {Exception} err
*   Error exception
*/
ESPTouch2.start(ssid, bssid, password, customData, aesKey).then(res => {
    //On success
    console.log(res.address, res.bssid);
}).catch(err => {
    //On error
    console.log(err);
});

/**
* Stop the configuration broadcasting
*/
ESPTouch2.stop();

/**
* Function called on broadcasting start
*/
ESPTouch2.onStart(() => {console.log('Starting broadcast')};

/**
* Function called on broadcasting stop
*/
ESPTouch2.onStop(() => {console.log('Stopping broadcast')};

贡献

看到 贡献指南 了解如何对存储库和开发工作流做出贡献。

许可证

麻省理工学院

版本与发布记录

-lorenzovecchi-react-native-esptouch-2-forked 共发布 35 个版本,首次发布于 2023/07/28;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.2.0latest2023/09/153 年前
0.1.372023/07/313 年前
0.1.362023/07/313 年前
0.1.352023/07/313 年前
0.1.342023/07/313 年前
0.1.332023/07/313 年前

关于 -lorenzovecchi-react-native-esptouch-2-forked 的常见问题

-lorenzovecchi-react-native-esptouch-2-forked 是什么?

用于配置ESP设备连接到目标AP分叉版本

如何安装 -lorenzovecchi-react-native-esptouch-2-forked?

在项目目录运行 npm install -- -lorenzovecchi-react-native-esptouch-2-forked,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(*)、react-native(*)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

-lorenzovecchi-react-native-esptouch-2-forked 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

-lorenzovecchi-react-native-esptouch-2-forked 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

-lorenzovecchi-react-native-esptouch-2-forked 可以商用吗?

-lorenzovecchi-react-native-esptouch-2-forked 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

-lorenzovecchi-react-native-esptouch-2-forked 还在维护吗?

最新版本 0.2.0 发布于 2023/09/15(3 年前);至今共发布 35 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/07/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。