{"id":22860073,"url":"https://github.com/reelyactive/audible-proximity","last_synced_at":"2025-08-09T06:11:29.283Z","repository":{"id":69136374,"uuid":"472790458","full_name":"reelyactive/audible-proximity","owner":"reelyactive","description":"Play audio files on a portable computer, like the Raspberry Pi, based on its proximity to Bluetooth beacons.  We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2022-11-02T14:51:41.000Z","size":1415,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-30T17:52:04.835Z","etag":null,"topics":["audio-guide","audio-player","audio-tour","bluetooth-beacons","proximity","raspberry-pi"],"latest_commit_sha":null,"homepage":"","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,"zenodo":null}},"created_at":"2022-03-22T13:54:51.000Z","updated_at":"2024-04-19T11:45:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"6ec7de73-6dea-48d5-abfb-a70748f598a9","html_url":"https://github.com/reelyactive/audible-proximity","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/reelyactive/audible-proximity","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Faudible-proximity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Faudible-proximity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Faudible-proximity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Faudible-proximity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/audible-proximity/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Faudible-proximity/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259851695,"owners_count":22921628,"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":["audio-guide","audio-player","audio-tour","bluetooth-beacons","proximity","raspberry-pi"],"created_at":"2024-12-13T09:08:52.211Z","updated_at":"2025-06-14T17:03:57.700Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"audible-proximity\n=================\n\nProgramatically play audio files on a portable computer, like the Raspberry Pi, based on its proximity to Bluetooth beacons.  If using a Pi, our [Prepare a headless Raspberry Pi from scratch](https://reelyactive.github.io/diy/pi-prep/) is the ideal starting point. \n\n\nInstallation\n------------\n\nClone this repository, and from its root folder, run `npm install` to install all dependencies.\n\nIf using a Pi, we recommend installing as follows:\n```\nmkdir ~/reelyActive\ncd ~/reelyActive\ngit clone https://github.com/reelyactive/audible-proximity.git\ncd audible-proximity\nnpm install\n```\n\n\nQuick Start\n-----------\n\nTo start __audible-proximity__ run `npm start` again from the root folder.\n\nIf an EPERM error is encountered, follow the instructions for [assigning privileges](https://github.com/reelyactive/barnowl-hci/#assigning-privileges) in barnowl-hci.\n\n\nPrerequisites\n-------------\n\n__audible-proximity__ requires the [mpg123](https://www.mpg123.de/) lightweight media player, which can easily be installed on Ubuntu/Debian Linux distributions (such as that on a Raspberry Pi) with the command `sudo apt install mpg123`\n\n\nAudio Files\n-----------\n\nBy default, audio files are expected to be found in the data/audio subfolder of this repository and have the form __xxxxxxx.mp3__ where each 'x' is a hexadecimal character (0-9 or a-f), for example 0123abc.mp3.\n\nA Bluetooth beacon transmitting an [InteroperaBLE Identifier](https://reelyactive.github.io/interoperable-identifier/) with the entity UUID __496f4944-434f-4445-b73e-2e2f2e6d7033__ will have its 28-bit instance ID interpreted as the filename of the associated .mp3 file.\n\nAn audio file is included to facilitate out-of-the-box testing (data/audio/0000000.mp3).  To trigger this audio file, configure a Bluetooth beacon (or a beacon simulator app for mobile devices) as Eddystone-UID with the following parameters:\n- _Namespace ID:_ 496f49442e2f2e6d7033\n- _Instance ID:_ 000000000000\n\n\nDebug Mode\n----------\n\nAlternatively, start __audible-proximity__ with the command `npm run debug` to print status updates to the console for debugging and to facilitate the tweaking of parameters.\n\n\nRun-on-Boot\n-----------\n\nTo run __audible-proximity__ automatically every time the Pi boots up:\n- Copy the unit file to the systemd system folder with the command `sudo cp units/audible-proximity-pi.service /lib/systemd/system`\n- Enable the audible-proximity service with the command `sudo systemctl enable audible-proximity-pi.service`\n- Start the audible-proximity service with the command `sudo systemctl start audible-proximity-pi.service`\n\nNote that it may be necessary to edit the WorkingDirectory and/or ExecStart paths to match the installed location of the __audible-proximity__ repository and npm, respectively.\n\n\nLicense\n-------\n\nMIT License\n\nCopyright (c) 2022 [reelyActive](https://www.reelyactive.com)\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%2Faudible-proximity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Faudible-proximity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Faudible-proximity/lists"}