{"id":28446942,"url":"https://github.com/os-js/osjs-wireless-tools-provider","last_synced_at":"2025-07-11T04:06:18.495Z","repository":{"id":55552234,"uuid":"168863273","full_name":"os-js/osjs-wireless-tools-provider","owner":"os-js","description":"OS.js Wireless-tools Service Provider","archived":false,"fork":false,"pushed_at":"2022-08-09T22:52:38.000Z","size":12,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-06T11:08:49.227Z","etag":null,"topics":["osjs","osjs-provider"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/os-js.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"andersevenrud","patreon":"andersevenrud","open_collective":"osjs","liberapay":"os-js","custom":"https://paypal.me/andersevenrud"}},"created_at":"2019-02-02T18:24:33.000Z","updated_at":"2023-12-14T06:20:03.000Z","dependencies_parsed_at":"2022-08-15T03:01:08.016Z","dependency_job_id":null,"html_url":"https://github.com/os-js/osjs-wireless-tools-provider","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/os-js/osjs-wireless-tools-provider","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-wireless-tools-provider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-wireless-tools-provider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-wireless-tools-provider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-wireless-tools-provider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/os-js","download_url":"https://codeload.github.com/os-js/osjs-wireless-tools-provider/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/os-js%2Fosjs-wireless-tools-provider/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260979075,"owners_count":23091926,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["osjs","osjs-provider"],"created_at":"2025-06-06T11:08:52.447Z","updated_at":"2025-06-30T06:32:26.110Z","avatar_url":"https://github.com/os-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/andersevenrud","https://patreon.com/andersevenrud","https://opencollective.com/osjs","https://liberapay.com/os-js","https://paypal.me/andersevenrud","https://www.patreon.com/user?u=2978551\u0026ty=h\u0026u=2978551","https://liberapay.com/os-js/"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"OS.js Logo\" src=\"https://raw.githubusercontent.com/os-js/gfx/master/logo-big.png\" /\u003e\n\u003c/p\u003e\n\n[OS.js](https://www.os-js.org/) is an [open-source](https://raw.githubusercontent.com/os-js/OS.js/master/LICENSE) web desktop platform with a window manager, application APIs, GUI toolkit, filesystem abstractions and much more.\n\n[![Support](https://img.shields.io/badge/patreon-support-orange.svg)](https://www.patreon.com/user?u=2978551\u0026ty=h\u0026u=2978551)\n[![Support](https://img.shields.io/badge/opencollective-donate-red.svg)](https://opencollective.com/osjs)\n[![Donate](https://img.shields.io/badge/liberapay-donate-yellowgreen.svg)](https://liberapay.com/os-js/)\n[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://paypal.me/andersevenrud)\n[![Community](https://img.shields.io/badge/join-community-green.svg)](https://community.os-js.org/)\n\n# OS.js wireless-tools Service Provider\n\nThis provider simply binds https://github.com/bakerface/wireless-tools to the internal API.\n\n## Installation\n\n```bash\nnpm install @osjs/wireless-tools-provider\n```\n\nIn your initialization scripts:\n\n```javascript\n// Client index.js file\nimport {WirelessToolsServiceProvider} from '@osjs/wireless-tools-provider';\nosjs.register(WirelessToolsServiceProvider);\n\n// Server index.js file\nconst {WirelessToolsServiceProvider} = require('@osjs/wireless-tools-provider/src/server.js');\nosjs.register(WirelessToolsServiceProvider);\n```\n\n## Configuration\n\nBy default the server provider is set up to only allow users with the `admin` group to access this feature.\n\nYou can change this by adding options:\n\n```javascript\nconst {WirelessToolsServiceProvider} = require('@osjs/wireless-tools-provider/src/server.js');\nosjs.register(WirelessToolsServiceProvider, {\n  args: {\n    groups: ['other-group']\n  }\n});\n```\n\n## API\n\nSimply use `core.make('osjs/wireless-tools').call('namespace', 'method', ...args)` and you will get a `Promise\u003cany, Error\u003e`.\n\nYou can also add subscriptions for these calls over websockets so that you get data on a regular interval:\n\n```javascript\n// Subscribe\ncore.make('osjs/wireless-tools')\n  .subscribe('ifconfig', 'status')\n  .then(subscription =\u003e {\n    // Attach a callback to get data when server pushes it out\n    subscription.bind(data =\u003e {\n      console.log(data)\n    });\n\n    // Unsubscribe when you're done\n    subscription.unsubscribe();\n  });\n```\n\nYou can see namespaces, method names and the return data in the wireless-tools documentation.\n\n## Features\n\n- Uses 1:1 function signatures (except promise instead of callback)\n- Support for subscriptions over websocket\n- Wifi connection settings via tray icon\n\n## TODO\n\n- [ ] Finish wifi tray icon\n- [ ] Add support for custom intervals on subscriptions\n- [ ] Add support for subscription emit only when data has changed\n\n## Contribution\n\n* **Sponsor on [Github](https://github.com/sponsors/andersevenrud)**\n* **Become a [Patreon](https://www.patreon.com/user?u=2978551\u0026ty=h\u0026u=2978551)**\n* **Support on [Open Collective](https://opencollective.com/osjs)**\n* [Contribution Guide](https://github.com/os-js/OS.js/blob/master/CONTRIBUTING.md)\n\n## Documentation\n\nSee the [Official Manuals](https://manual.os-js.org/) for articles, tutorials and guides.\n\n## Links\n\n* [Official Chat](https://gitter.im/os-js/OS.js)\n* [Community Forums and Announcements](https://community.os-js.org/)\n* [Homepage](https://os-js.org/)\n* [Twitter](https://twitter.com/osjsorg) ([author](https://twitter.com/andersevenrud))\n* [Google+](https://plus.google.com/b/113399210633478618934/113399210633478618934)\n* [Facebook](https://www.facebook.com/os.js.org)\n* [Docker Hub](https://hub.docker.com/u/osjs/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fos-js%2Fosjs-wireless-tools-provider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fos-js%2Fosjs-wireless-tools-provider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fos-js%2Fosjs-wireless-tools-provider/lists"}