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()
• listNetworks()
• manuallyConnect(...)
• getVersion()

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
• no_networks_found
• connection_loss

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.