0.0.4 • Published 8 years ago

resin-wifivisor v0.0.4

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
8 years ago

resin-wifivisor

a supervisor-like set of endpoints that enables wifi management under resin containers

Dependencies

  • connman
  • libdbus-1-dev
  • libglib2.0-dev

on Debian/Ubuntu :

sudo apt-get update && sudo apt -get install connman libdbus-1 libglib2.0-dev -y

Installation

npm i resin-wifivisor --save

Usage

const Wifi = require('resin-wifivisor');

Wifi.init();

Wifi.on('error', function(err) {
    console.error(err)
});

Wifi.on('start', function(port) {
    console.log("wifi manager listening on port " + port);
});

Wifi.on('connect', function(ssid) {
    console.log('connected to ' + ssid);
});

Wifi.on('disconnect', function() {
    console.log("disconnected");
});

Wifi.on('hotspot', function(data) {
    if (data.active) {
        console.log("hotspot enabled with SSID: " + data.ssid + " and passphrase: " + data.psk);
    } else {
        console.log("hotspot disabled");
    }
});

Wifi.on('powered', function(status) {
    if (status) {
        console.log("Wifi enabled");
    } else {
        console.log("Wifi disabled");
    }
});

APIs

  • You can set the port on which to expose the webserver via WIFIVISOR_CONFIG_PORT env-var (defaults to 3000)
  • You can set the connections configuration path via WIFIVISOR_CONFIG_DIR env-var (defaults to /data/wifi/)
Get WiFi state
EndpointMethodResponseDescription
/v1/wifi/stateGETempty 200 OKreturns the current state of the Wifi chip
Set WiFi power mode to ON
EndpointMethodResponseDescription
/v1/wifi/statePUTempty 200 OKpowers ON the WiFi chip
Set WiFi power mode to OFF
EndpointMethodResponseDescription
/v1/wifi/stateDELETEempty 200 OKpowers OFF the WiFi chip
Scan WiFi
EndpointMethodResponseDescription
/v1/wifi/GETobj 200 OKscans for Wifi access points
Connect
EndpointMethodResponseDescription
/v1/wifi/<ssid>/<psk>POSTobj 200 OKconnects to a given Wifi access point with given SSID and PSK
Disconnect
EndpointMethodResponseDescription
/v1/wifi/DELETEempty 200 OKdisconnects to any current Wifi access point
Hotspot ON
EndpointMethodResponseDescription
/v1/wifi/hotspot/<ssid>/<psk>POSTobj 200 OK or 500 INTERNAL SERVER ERRORenables the Hotspot mode with given SSID and PSK
Hotspot OFF
EndpointMethodResponseDescription
/v1/wifi/hotspot/DELETEempty 200 OKdisables the Hotspot mode
Get Configs
EndpointMethodResponseDescription
/v1/wifi/config/GETobj 200 OK or 500 INTERNAL SERVER ERRORgets already configured connections
Save config
EndpointMethodResponseDescription
/v1/wifi/config/<ssid>/<psk>POSTempty 200 OK or 500 INTERNAL SERVER ERRORsave connection config
Delete config
EndpointMethodResponseDescription
/v1/wifi/config/<ssid>DELETEempty 200 OK or 500 INTERNAL SERVER ERRORdelete connection config

License

Copyright 2016 Rulemotion Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

0.0.4

8 years ago

0.0.3

8 years ago

0.0.2

8 years ago

0.0.1

8 years ago