{"id":21331144,"url":"https://github.com/netbeast/docs","last_synced_at":"2026-02-02T19:32:50.388Z","repository":{"id":31653650,"uuid":"35218979","full_name":"netbeast/docs","owner":"netbeast","description":":book: Start developing IoT Apps with Netbeast. Gitbook repository.","archived":false,"fork":false,"pushed_at":"2017-05-20T14:04:05.000Z","size":15394,"stargazers_count":38,"open_issues_count":1,"forks_count":6,"subscribers_count":10,"default_branch":"master","last_synced_at":"2026-01-14T13:24:49.567Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://netbeast.co/docs","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netbeast.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-07T12:33:33.000Z","updated_at":"2025-10-23T04:09:53.000Z","dependencies_parsed_at":"2022-09-10T06:21:43.548Z","dependency_job_id":null,"html_url":"https://github.com/netbeast/docs","commit_stats":null,"previous_names":["netbeast-co/xway"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/netbeast/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbeast%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbeast%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbeast%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbeast%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netbeast","download_url":"https://codeload.github.com/netbeast/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbeast%2Fdocs/sbom","scorecard":{"id":680606,"data":{"date":"2025-08-11","repo":{"name":"github.com/netbeast/docs","commit":"9f0cdc93f5b490cbf6f9ff1f71f6de18bbb44098"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":2,"reason":"8 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-21T23:00:31.836Z","repository_id":31653650,"created_at":"2025-08-21T23:00:31.836Z","updated_at":"2025-08-21T23:00:31.836Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29018015,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T18:51:31.335Z","status":"ssl_error","status_checked_at":"2026-02-02T18:49:20.777Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-21T22:29:34.440Z","updated_at":"2026-02-02T19:32:50.360Z","avatar_url":"https://github.com/netbeast.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# About Netbeast\n\nThis documentation will show you all there is to know about Internet of Things development with Netbeast. For basic info on what Netbeast is about, please see [the main project github repository](https://github.com/netbeast).\n\nAnxious to start right away?\n\n[Get Started](chapters/getting_started/installing_and_cloning.md)\n\n\u003ca href=\"https://getyeti.co\" rel=\"some text\"\u003e![works-with-yeti](/img/works-with-yeti.png)\u003c/a\u003e\n\nNetbeast is developing the mobile application based on this open source project. If you want to get the mobile app go to the main website [here](https://getyeti.co)\n\nThe app is available on the [AppStore](http://m.onelink.me/4e70ec81) for iOS and also on the [PlayStore](http://m.onelink.me/444eef11) for Android devices\n\n## What is Netbeast?\n\nAs our Github reads:\n\nNetbeast is an open source platform that allows to connect IoT devices regardless of anything.\n\nMore specifically, Netbeast is:\n\n* A Toolbelt that let's you develop Internet of Things applications easier and faster.\n* A platform that hosts your applications and does the hard work of specifically talking to every device.\n\nLogically, it makes sense to combine the use of both to create and offer IoT applications to everyone. Let's have a peek at how it works.\n\n\n## Hello world\n\nOur \"Hello World\" IoT version is a small application that turns a light into any color we want.\n\n```\nvar beast = require('netbeast')\n\n    beast('lights').set({\n      color: \"#9AD74C\",\n      power: \"on\"\n    })\n```\nHere, the application is using:\n\n[The Netbeast API](http://docs.netbeast.co/chapters/api_reference/index.html) to tell a light, any light, to turn on and with a lime green color.\n\n[The Netbeast Dashboard](chapters/getting_started/dashboard.md) is running on the device where this application is running. This allow to translate messages from any kind of devices.\n\nAnd that's all there is to it. Using the same principle one can control any device (lights, sound systems, TVs, appliances...).\n\n\n## Apps \u0026 Plugins\n\nThat's how you use the API to develop applications. The API itself uses [plugins](http://docs.netbeast.co/chapters/creating_a_plugin/write_your_first_plugin.md) to communicate specifically with each brand's devices. Plugins are modular and specific to a certain vendor API or protocol.\n\n\n## Dashboard\n\nThe dashboard hosts and runs applications. It provides a user interface from which you can access and manage all your applications.\n\n\n![Demo Dashboard](/img/dashboard-demo.gif)\n\n\n## About these docs\n\nThis documentation is broken down into four parts:\n* Getting started does an overview of all the tools available and walks you through the setup process on every available platform.\n* Developing teaches you all there is to know about creating applications and plugins for connected products.\n* API reference is the place to go to learn everything about the Netbeast API and its methods.\n* Contributing provides all the guidelines necessary to submit your code and help improve Netbeast.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetbeast%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetbeast%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetbeast%2Fdocs/lists"}