{"id":22859944,"url":"https://github.com/reelyactive/rtlips-server","last_synced_at":"2025-03-31T08:22:44.461Z","repository":{"id":69137133,"uuid":"101293834","full_name":"reelyactive/rtlips-server","owner":"reelyactive","description":"Real-Time Location \u0026 Indoor Positioning System server.  We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2017-10-24T23:15:37.000Z","size":13,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-20T00:02:10.762Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reelyactive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-24T12:43:54.000Z","updated_at":"2023-01-13T12:25:40.000Z","dependencies_parsed_at":"2023-05-02T16:31:20.504Z","dependency_job_id":null,"html_url":"https://github.com/reelyactive/rtlips-server","commit_stats":{"total_commits":19,"total_committers":1,"mean_commits":19.0,"dds":0.0,"last_synced_commit":"8d92223d5419167e403f72b27547de2cb8650a9d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Frtlips-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Frtlips-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Frtlips-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Frtlips-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/rtlips-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246436874,"owners_count":20777110,"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":[],"created_at":"2024-12-13T09:08:30.041Z","updated_at":"2025-03-31T08:22:44.439Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"rtlips-server\n=============\n\nReal-Time Location \u0026amp; Indoor Positioning System server.  Combines the following:\n- real-time contextual events from [Pareto](https://getpareto.com) or [hlc-server](https://www.npmjs.com/package/hlc-server) (RTLS)\n- real-time BLE (beacon) site surveys from mobile devices (IPS)\n- simple positioning algorithms\n\nThe real-time location/positioning data stream can be consumed using websockets.\n\n\nInstallation\n------------\n\n    npm install rtlips-server\n\n\nHello rtlips-server\n-------------------\n\n```javascript\nconst rtlipsServer = require('rtlips-server');\n\nconst options = { /* See options */ };\n\nvar app = new rtlipsServer(options);\n\n// Connect to Pareto websocket (requires token)\napp.connect('https://pareto.reelyactive.com',\n            { query: { token: 'paste from Pareto' } });\n\n// Connect to a local hlc-server instance\napp.connect('http://localhost:3001');\n```\n\nThen connect a websocket client to http://localhost:3007 and listen for 'appearance', 'displacement', 'keep-alive' and 'disappearance' events.  See our [Build web apps with beaver.js](https://reelyactive.github.io/build-web-apps-with-beaver.html) tutorial for everything you need to quickly get up and running.\n\n\nReceiving mobile site surveys\n-----------------------------\n\nPOST mobile site surveys to the __/events__ route (ex: http://localhost:3007/events).  The mobile site survey must have, at a minimum, the following properties:\n\n    {\n      \"event\": \"keep-alive\",\n      \"time\": 1420075425678,\n      \"deviceAssociationIds\": [ \"/* BLE UUID */\" ],\n      \"rssiSignature\": {\n        \"beacon_id_0\": rssi_0,\n        \"beacon_id_1\": rssi_1, ...\n      }\n    }\n\nwhere the __beacon_id__ values are the identifiers of the detected beacons given as _lowercase hexadecimal strings without separators_ (ex: \"7265656c79416374697665205555494400000000\", which is a concatenated iBeacon UUID, Major, Minor), and the __rssi__ values are _numbers_.\n\nIf the mobile device advertises a Bluetooth Low Energy UUID, be sure to include this in the __deviceAssociationIds__ array, else provide an empty array.\n\n\nOptions\n-------\n\nThe following options are accepted at run-time.\n\n### references\n\nAdd a __references__ property to the options to specify all the reference devices (with known positions).  For example:\n\n    references: {\n      \"001bc50940810000\": { position: [ 0, 0 ] },\n      \"001bc50940810001\": { position: [ 10, 10 ] }\n    }\n\n### pullFactor\n\nAdd a __pullFactor__ property to the options to adjust the pull factor in the anchor-and-pull positioning method.  The default value is 2.  Values should be 1 or greater.\n\n    pullFactor: 2\n\n\nLicense\n-------\n\nMIT License\n\nCopyright (c) 2017 reelyActive\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR \nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, \nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE \nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER \nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, \nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN \nTHE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Frtlips-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Frtlips-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Frtlips-server/lists"}