Catalog npm
Back to packageRELEASE DETAILS

0.1.29

npm

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

used to configure ESP devices to connect to target AP - forked version

androidiosreact-native
Published31 Jul 2023
Direct dependencies19
Transitive dependenciesNot calculated

README

Current package documentation

react-native-esptouch-2

I forked this repo to edit package react-native-esptouch-2 created by https://www.npmjs.com/package/@lorenzovecchi/react-native-esptouch-2/v/0.1.4

Used to configure ESP devices to connect to target AP

  • Support both Android and iOS
  • iOS code is untested

This is a Unofficial project. The official demo is below:

EsptouchForAndroid

EsptouchForIOS

Installation

Install the module from npm

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

Android

Add permissions in 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

Usage

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')};

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 21

Native requirements
19 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@commitlint/config-conventional
Environment
{
  "local_name": "@commitlint/config-conventional",
  "alias": false,
  "peer_metadata": null
}
^11.0.0development
@react-native-community/eslint-config
Environment
{
  "local_name": "@react-native-community/eslint-config",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
@release-it/conventional-changelog
Environment
{
  "local_name": "@release-it/conventional-changelog",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
@types/jest
Environment
{
  "local_name": "@types/jest",
  "alias": false,
  "peer_metadata": null
}
^26.0.0development
@types/react
Environment
{
  "local_name": "@types/react",
  "alias": false,
  "peer_metadata": null
}
^16.9.19development
@types/react-native
Environment
{
  "local_name": "@types/react-native",
  "alias": false,
  "peer_metadata": null
}
0.62.13development
commitlint
Environment
{
  "local_name": "commitlint",
  "alias": false,
  "peer_metadata": null
}
^11.0.0development
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^7.2.0development
eslint-config-prettier
Environment
{
  "local_name": "eslint-config-prettier",
  "alias": false,
  "peer_metadata": null
}
^7.0.0development
eslint-plugin-prettier
Environment
{
  "local_name": "eslint-plugin-prettier",
  "alias": false,
  "peer_metadata": null
}
^3.1.3development
husky
Environment
{
  "local_name": "husky",
  "alias": false,
  "peer_metadata": null
}
^6.0.0development
jest
Environment
{
  "local_name": "jest",
  "alias": false,
  "peer_metadata": null
}
^26.0.1development
pod-install
Environment
{
  "local_name": "pod-install",
  "alias": false,
  "peer_metadata": null
}
^0.1.0development
prettier
Environment
{
  "local_name": "prettier",
  "alias": false,
  "peer_metadata": null
}
^2.0.5development
react
Environment
{
  "local_name": "react",
  "alias": false,
  "peer_metadata": null
}
16.13.1development
react-native
Environment
{
  "local_name": "react-native",
  "alias": false,
  "peer_metadata": null
}
0.63.4development
react-native-builder-bob
Environment
{
  "local_name": "react-native-builder-bob",
  "alias": false,
  "peer_metadata": null
}
^0.18.0development
release-it
Environment
{
  "local_name": "release-it",
  "alias": false,
  "peer_metadata": null
}
^14.2.2development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^4.1.3development
react
Environment
{
  "local_name": "react",
  "alias": false,
  "peer_metadata": null
}
*peer
react-native
Environment
{
  "local_name": "react-native",
  "alias": false,
  "peer_metadata": null
}
*peer

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "integrity": "sha512-8WjRPZLahXDS3ty/KVIk7qCIl2yoPLye+6tSPcon4HV0J6zzyI8gP2b1aySCUO79gI/0BgftysL99uLf0dlZCw==",
  "shasum": "b3a20d13bf9230c341569ea54f2e6ebbc7f06b2b",
  "tarball": "https://registry.npmjs.org/-lorenzovecchi-react-native-esptouch-2-forked/-/-lorenzovecchi-react-native-esptouch-2-forked-0.1.29.tgz",
  "fileCount": 129,
  "unpackedSize": 1169274,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEUCIGAjn8v/ba2bGjUYEGUD9u8XXfcK+AEajaoFSB7qLOspAiEAjHrzTe4h1GmqYufcQKipwlS2okyq7yJW50LIU5qqQOA="
    }
  ]
}

Repository

PENDING
lorenzovecchi/react-native-esptouch-2

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 16:05 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:bd38bacf25871ee3a8fcb2e39219013c2aa3f563339d07e23d479211ce3547ea

Other collected versions

0.2.015 Sept0.1.3731 Jul0.1.3631 Jul0.1.3531 Jul0.1.3431 Jul0.1.3331 JulView all collected versions →