OS.js is an open-source web desktop platform with a window manager, application APIs, GUI toolkit, filesystem abstractions and much more.
This provider simply binds https://github.com/bakerface/wireless-tools to the internal API.
npm install @osjs/wireless-tools-provider
In your initialization scripts:
// Client index.js file
import {WirelessToolsServiceProvider} from '@osjs/wireless-tools-provider';
osjs.register(WirelessToolsServiceProvider);
// Server index.js file
const {WirelessToolsServiceProvider} = require('@osjs/wireless-tools-provider/src/server.js');
osjs.register(WirelessToolsServiceProvider);
By default the server provider is set up to only allow users with the admin
group to access this feature.
You can change this by adding options:
const {WirelessToolsServiceProvider} = require('@osjs/wireless-tools-provider/src/server.js');
osjs.register(WirelessToolsServiceProvider, {
args: {
groups: ['other-group']
}
});
Simply use core.make('osjs/wireless-tools').call('namespace', 'method', ...args)
and you will get a Promise<any, Error>
.
You can also add subscriptions for these calls over websockets so that you get data on a regular interval:
// Subscribe
core.make('osjs/wireless-tools')
.subscribe('ifconfig', 'status')
.then(subscription => {
// Attach a callback to get data when server pushes it out
subscription.bind(data => {
console.log(data)
});
// Unsubscribe when you're done
subscription.unsubscribe();
});
You can see namespaces, method names and the return data in the wireless-tools documentation.
- Uses 1:1 function signatures (except promise instead of callback)
- Support for subscriptions over websocket
- Wifi connection settings via tray icon
- Finish wifi tray icon
- Add support for custom intervals on subscriptions
- Add support for subscription emit only when data has changed
- Sponsor on Github
- Become a Patreon
- Support on Open Collective
- Contribution Guide
See the Official Manuals for articles, tutorials and guides.