Skip to content

Latest commit

 

History

History
110 lines (77 loc) · 5.32 KB

README.md

File metadata and controls

110 lines (77 loc) · 5.32 KB

Welcome to the UriBeacon
Open Source Project

Build Status

The Web Uri Open Beacon specification for the Internet of Things

(pronounced YUR-ee-BEE-kun)

Are you a UriBeacon Developer? Open an issue and we will point you at resources to help development and testing.

Are you looking for UriBeacon Products? Visit Blesh and see the flashable implementations on the gitub repo.

Interested in the big picture? Check out how UriBeacons are used in the Physical Web project.

Disclaimer

This is not an official Google product. This is an early-stage experiment that we are developing in the open as we do all things related to the web. This should only be of interest to developers looking to provide feedback and contribute.

Why We Created the UriBeacon Specification

The UriBeacon Specification is designed with one goal in mind: to create the easiest, most open way to discover and use nearby smart things.

UriBeacon is a wireless advertisement format for broadcasting Uris to any nearby smart device. By leveraging the Open Web it enables a real-World Wide Web where every person, place and thing can have its own Web presence. Our design is:

  1. Compliant with Bluetooth 4.0 Advertising messages.
  2. Compatible with iOS and Android low power scanning modes.
  3. Independent of any particular hardware, user-agent, service or mobile platform.
  4. Openly licensed under Apache 2.0 and as such free of restrictive and proprietary terms.

In short, UriBeacon connects low power beacons to the family of Open Web technologies and is one step towards making the Internet of Things as easy to use as the World Wide Web.

Contents

This repository contains the UriBeacon written specification and sample code for advertisers and scanners:

We will also be providing instructions on how to assemble and program standalone UriBeacon tags.

The releases tab contains the UriBeacon Developer Tools.

What is a Uri?

One can classify URIs as Locators (URLs), or Names (URNs), or both.

A Name functions like a person’s name (or Government ID number), while a Locator resembles that person’s postal address.

In other words: URN is an item’s identity, while the URL is a method for finding it.

  • urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6 RFC4122
  • https://www.ietf.org/rfc/rfc2141.txt RFC1738

UriBeacons can broadcast familiar HTTP URLs (http and https), UUID URNs (128-bit universally unique identifiers) as well as other URIs.

UriBeacon Devices and Tags

Various things may broadcast UriBeacons. Smart devices such as phones, tablets, laptops, vending machines, irrigation controllers may incorporate built in UriBeacons. Other things such as movie posters, bus stops, and meeting rooms may use small hardware devices, or tags, specifically designed to emit a UriBeacon advertisement. The libraries and sample code in this repository are a resource for developers who want to encorporate UriBeacons in existing devices and also to create standalone UriBeacon tags.

Short Urls

In order to allow arbitrary sized Urls in short messages the specification finds inspiration from Twitter where all Url links posted in Tweets are auto-shortened. Similarly the UriBeacon contains either a naturally short Uri or one that is shortened through a third-party service. The actual Uri shortener service used is up to the tag writer.

UriBeacon also uses an encoding that replaces common strings like https:// with a single byte code. The result are Uris that can fit within the limited size of ADV_NONCONN_IND packets as shown in the table below:

Service Example Length Encoded Length
goo.gl http://goo.gl/lNhc7 19 13
bit.ly http://bit.ly/a99vaw 20 14
is.gd http://is.gd/EstPIk 19 13
t.co http://t.co/LEGhQ4i0 20 14

Table 1: Sampling of Url Shorteners

Note that short Urls are mostly transparent: user agents can hide short and show long URLs, titles, etc. and configuration tools can automatically shorten long Urls when writing beacons. Also this specification does not preclude additional information exchange over a GATT service following discovery.