Note: For Eddystone, see this page

iBeacon is a beacon format from Apple that allows you to transmit information which can appear as a notification on a user's iPhone.

All you need to do to use it is use the ble_ibeacon (About Modules) module:

  uuid : [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], // ibeacon uuid
  major : 0x0001, // optional
  minor : 0x0001, // optional
  rssi : -59 // optional RSSI at 1 meter distance in dBm

Note: you'll need to get an iBeacon UUID from Apple to use this.

From then on, Puck.js will broadcast to anything that will listen.

Note: Since you can't advertise while you're connected via Bluetooth LE, you will have to disconnect from your Puck for it to start transmitting.

To turn iBeacon advertising off simply call NRF.setAdvertising({});


You can also use require("ble_ibeacon").get with the same options as advertise to get the array of advertising data to use. You can feed this directy into NRF.setAdvertising()'s first argument and can set other options such as advertising rate.

In Puck.js 1v92 You can also supply an array of advertising data:

  {} // this will add a 'normal' advertising packet showing name/etc  
  ], {interval:100});

In which case Puck.js will send each advertising packet in turn.

This library's default behaviour is to overwrite Puck.js's advertising (name, services, etc) with iBeacon. However you can easily add the advertising in addition to Espruino's existing advertising by setting the Eddystone advertising inside the Advertising Scan Response:


This page is auto-generated from GitHub. If you see any mistakes or have suggestions, please let us know.