npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@educabot/codit-connection-plugin

v0.8.0

Published

connects to codit

Downloads

1

Readme

codit-connection-plugin

Include this plugin in a Capacitor app in order to connect to Codit devices.

System requirements

Android: SDK version >= 29 (i.e. OS version >= 10) and location permissions.

Install

npm install @educabot/codit-connection-plugin
npx cap sync

API

setupConnections()

setupConnections() => Promise<{ done: boolean; error?: string; }>

Attempts to connect to the best Codit network available.

  • Android: "best" is defined by the strongest signal
  • iOS: "best" is defined by whatever Apple decides

Returns: Promise<{ done: boolean; error?: string; }>


listNetworks()

listNetworks() => Promise<{ done: boolean; error?: string; }>
  • Android: scans the available Wi-Fi networks and returns the list.
  • iOS: does nothing.

Returns: Promise<{ done: boolean; error?: string; }>


manuallyConnect(...)

manuallyConnect({ SSID, BSSID }: { SSID: string; BSSID: string; }) => Promise<{ done: boolean; error?: string; }>

Attempts to connect to the Codit network indicated.

  • Android: uses both SSID and BSSID to determine and join the network.
  • iOS: uses the SSID to join the network, ignores the BSSID.

| Param | Type | | --------- | --------------------------------------------- | | __0 | { SSID: string; BSSID: string; } |

Returns: Promise<{ done: boolean; error?: string; }>


getVersion()

getVersion() => Promise<{ version: string; }>

Returns the version of the plugin.

Returns: Promise<{ version: string; }>


Events

connection_success

Fired when the plugin successfully connects to a Codit device.

  • Android: includes the device's BSSID in the BSSID field.
  • iOS: this event means that the device is ok to attempt to join the network, but does not guarantee the connection will be successful.

no_networks_found

Fired when the call to setupConnections did not find any nearby Codit devices.

connection_loss

Fired when the current connection is lost, due to the Codit device being turned off or due to it being moved too far from the device.

Developing this plugin

Make sure to have both the robots-app repository and this one on the same folder (same level).

  1. npm install
  2. npm run build
  3. Replace the value for @educabot/codit-connection-plugin in the package.json file in robots-app with "../codit-connection-plugin"
  4. npm install in robots-app
  5. Done!

From this point on, all changes done to the plugin will be automatically picked up by the app.

Just make sure to put the values in package.json back and run npm install again before committing changes.

Release

DO NOT CHANGE THE VERSION MANUALLY. Use the script:

bump <version>

This makes sure to update the version in all the places that matter.