Skip to content

Latest commit

 

History

History
118 lines (66 loc) · 6.49 KB

README.md

File metadata and controls

118 lines (66 loc) · 6.49 KB

DirAct

DirAct is embedded software for proximity interaction detection: Who is interacting with whom/what? The lightweight code runs on Bluetooth Low Energy wearables, badges and beacons.

DirAct Logo

DirAct is written in JavaScript for Espruino, which runs on just about any device with a Nordic nRF52 microcontroller, and can be programmed through the web browser using the Espruino Web IDE. DirAct advertising packets can be decoded by the advlib-ble-manufacturers library which is part of reelyActive's Pareto Anywhere open source middleware suite.

Learn more at reelyactive.com/diract and at reelyactive.github.io/diract.

Programming Espruino devices with DirAct

The following Espruino devices are supported.

Puck.js

Code is available in the puckjs folder of this repository. See our Puck.js Development Guide for detailed programming instructions.

Pixl.js

Code is available in the pixljs folder of this repository.

Bangle.js

DirAct is available directly from the Bangle App Loader. For development, see our Bangle.js Development Guide tutorial for detailed programming instructions.

Code for the original Bangle.js v1 is available in the banglejs folder of release-0.1 of this repository.

ca-va-bracelet

Code is available in the ca-va-bracelet folder of this repository. See the ca-va-bracelet open hardware project based on the MDBT42Q module, which runs Espruino.

Programming other devices with DirAct

The following devices which can be programmed to run Espruino are supported.

micro:bit v2

Code for the BBC micro:bit v2 (the version with the microphone, speaker and a nRF52833 microcontroller) is available in the microbit-v2 folder of this repository. See the Espruino micro:bit guide for programming instructions.

DirAct Identifiers

Each DirAct device shall identify itself with a unique INSTANCE_ID. By default, the two least-significant bytes of the nRF advertiser address are used as the unique INSTANCE_ID, unless a specific ID is entered, as below:

// Auto-generate a unique INSTANCE_ID:
const INSTANCE_ID = null;
// Specify INSTANCE_ID of 00000001
const INSTANCE_ID = new Uint8Array([ 0x00, 0x00, 0x00, 0x01 ]);

DirAct devices recognise not only their peers, but also beacons which transmit an InteroperaBLE Identifier with the DirAct entity UUID (496f4944446972416374).

DirAct devices transmit advertising packets which include manufacturer specific data using the Bluetooth-SIG-assigned Company Identifier of Code Blue Consulting (0x0583), the co-developers of DirAct. Developers may continue to use this company identifier for experimental and educational purposes. However, company identifier 0x0583 may NOT be used for commercial use of the DirAct embedded software. An entity may request a company identifier from the Bluetooth SIG and use this instead. Contact us if in doubt.

DirAct filters on AOS 8.x

HPE Aruba Networking access points running AOS 8.x offer a DirAct filter for forwarding BLE Data in their IoT WebSocket Interface. Note that the DirAct checkbox has the behaviour of forwarding only DirAct digest packets.

DirAct AOS8 filtering

In order to forward both DirAct proximity and digest packets, instead include a Company Identifier filter with the value 0583.

See our Configure an Aruba Instant AP tutorial for more details on this integration.

Project History

DirAct is jointly developed by reelyActive and Code Blue Consulting. The code was open sourced as v0.x in 2019.

DirAct v1.x, released at the start of the COVID-19 pandemic, added a digest feature to facilitate contact tracing in environments with sparse infrastructure.

DirAct v2.x, released in 2023, fully adopts the InteroperaBLE Identifier, and supports the digest and non-digest variants independently as diract-digest.js and diract.js, respectively.

Contributing

Discover how to contribute to this open source project which upholds a standard code of conduct.

Security

Consult our security policy for best practices using this open source software and to report vulnerabilities.

License

MIT License

Copyright (c) 2019-2023 reelyActive

Permission 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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.