-
Notifications
You must be signed in to change notification settings - Fork 3
/
integrate-your-product.html
283 lines (280 loc) · 15.4 KB
/
integrate-your-product.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<!DOCTYPE HTML>
<html>
<head>
<title>diyActive: Integrate your Product</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Guide to integrating products with the reelyActive platform. Your product will be radio-identifiable and digitally represented in a standard format on the web.">
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
<link rel="stylesheet" href="style/main.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.6.2/angular.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/angular-ui-bootstrap/2.5.0/ui-bootstrap-tpls.min.js"></script>
<script type="text/javascript" src="js/cormorant.js"></script>
<script type="text/javascript" src="js/product.js"></script>
</head>
<body>
<body ng-app="product">
<div ng-controller="ProductCtrl as $ctrl">
<nav class="navbar navbar-default" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle"
ng-init="navCollapsed = true"
ng-click="navCollapsed = !navCollapsed">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="https://www.reelyactive.com">
<strong>reely</strong>Active
</a>
</div>
<div class="collapse navbar-collapse" ng-class="!navCollapsed && 'in'"
ng-click="navCollapsed = true">
<ul class="nav navbar-nav navbar-right">
<li class="active"><a href="/"> diyActive </a></li>
<li class="dropdown" uib-dropdown on-toggle="toggled(open)">
<a href class="dropdown-toggle" uib-dropdown-toggle role="button"
data-toggle="dropdown" aria-haspopup="true"
aria-expanded="false">
Quick links <span class="caret"></span>
</a>
<ul class="dropdown-menu" uib-dropdown-menu role="menu">
<li role="menuitem">
<a href="https://github.com/reelyactive/" target="_blank">
reelyActive on GitHub
</a>
</li>
<li role="menuitem">
<a href="https://www.npmjs.com/~reelyactive" target="_blank">
reelyActive on npmjs
</a>
</li>
<li role="separator" class="divider"></li>
<li role="menuitem">
<a href="https://www.reelyactive.com" target="_blank">
reelyActive website
</a>
</li>
<li role="menuitem">
<a href="https://getpareto.com" target="_blank">
Pareto by reelyActive
</a>
</li>
<li role="separator" class="divider"></li>
<li role="menuitem">
<a href="https://shop.reelyactive.com" target="_blank">
Our online store
</a>
</li>
<li role="menuitem">
<a href="https://reelyactive.com/blog/" target="_blank">
Our blog
</a>
</li>
</ul>
</li>
</ul>
</div>
</nav>
<div class="container-fluid">
<div class="row">
<div class="col-xs-0 col-sm-1 col-md-2 col-lg-3"></div>
<div class="col-xs-12 col-sm-10 col-md-8 col-lg-6">
<h1> Integrate your Product </h1>
<p> The reelyActive platform recognises and represents people, products and places within physical spaces via any radio-identifiable devices they may carry. Here we'll explain how to integrate <b><i>your</i></b> <a href="#identification">identifiable</a> product by ensuring it is appropriately <a href="#representation">represented</a> on the web and <a href="#association">associated</a> within our platform. </p>
<img src="images/product-interpretation.gif"
class="img-responsive center-block img-thumbnail">
<br>
<p class="text-center">
<a class="btn btn-primary"
href="#identification"> Identification </a>
<a class="btn btn-primary"
href="#representation"> Representation </a>
<a class="btn btn-primary"
href="#association"> Association </a>
</p>
<hr>
<p><br><br></p>
<a id="identification"></a>
<img src="images/product-identification.png"
class="img-responsive center-block">
<h2> Identification <br>
<small> Your product needs to be uniquely identifiable by radio. </small> </h2>
<p> Our platform currently supports the billions of Bluetooth Low Energy (BLE) devices in existence. Each of these has the potential to broadcast a unique identifier which can be recognised by devices in range, such as our reelceivers. The following examples illustrate how individual products, or products of a specific brand, are identified. </p>
<table class="table table-striped table-reelyactive">
<caption> EXAMPLES OF PRODUCTS IDENTIFIABLE BY BLE </caption>
<thead>
<tr>
<th> Product </th>
<th> Identifier Type </th>
<th> Identifier Value (Hexadecimal) </th>
</tr>
</thead>
<tbody>
<tr>
<td> Tile </td>
<td> 16-bit UUID </td>
<td> <tt>feed</tt> </td>
</tr>
<tr>
<td> Samsung Products </td>
<td> 16-bit Company Code </td>
<td> <tt>0075</tt> </td>
</tr>
<tr>
<td> Nexus Player </td>
<td> 128-bit UUID </td>
<td> <tt>cbbfe0e1f7f3420684e084cbb3d09dfc</tt> </td>
</tr>
<tr>
<td> Estimote Beacon </td>
<td> iBeacon UUID </td>
<td> <tt>b9407f30f5f8466eaff925556b57fe6d</tt> </td>
</tr>
</tbody>
</table>
<p> If you have a Bluetooth Low Energy product, and you know the identifier it broadcasts, great! If you don't know what identifier it broadcasts, if at all, ask your engineering team. Our <a href="http://reelyactive.github.io/advlib/" target="_blank">advlib</a> tool may come in handy. </p>
<p> Don't have a Bluetooth Low Energy product? Do not despair. In future we intend to integrate RAIN RFID devices which are likely to number in the trillions! <i>Read on nonetheless - if nothing else you'll learn a nifty SEO trick!</i> </p>
<hr>
<p><br><br></p>
<a id="representation"></a>
<img src="images/product-representation.png"
class="img-responsive center-block">
<h2> Representation <br>
<small> Your product needs to be represented in a format that computers can understand. </small> </h2>
<p> Our platform understands products <a href="https://developers.google.com/search/docs/guides/intro-structured-data" target="_blank">the same way as the major search engines</a>: using <a href="https://schema.org/" target="_blank">schema.org</a> and <a href="http://json-ld.org/" target="_blank">JSON-LD</a>. Don't worry if those are unfamiliar terms, you don't actually need to know what they mean nor how they work! </p>
<h3> Represent your product </h3>
<p> All you need to do is to digitally represent your product by pasting some code into its webpage. Simply create that code by filling in the fields below, then click Export to Web. </p>
<div class="row">
<div class="col-xs-12 col-md-5">
<form role="form">
<div class="form-group">
<label for="productName"> Name: </label>
<input type="text" ng-change='change()'
placeholder="Bluetooth Smart Reelceiver"
class="form-control" ng-model="product.name"
tooltip="Ex:Bluetooth Smart Reelceiver"
tooltip-placement="right" id="productName"/>
</div>
<div class="form-group">
<label for="productManufacturer"> Manufacturer: </label>
<input type="text" placeholder="reelyActive"
class="form-control" tooltip-placement="right"
ng-model="product.manufacturer.name"
ng-change='change()' tooltip="Ex:reelyActive"
id="productManufacturer"/>
</div>
<div class="form-group">
<label for="productModel"> Model: </label>
<input type="text" placeholder="RA-R436"
class="form-control" ng-model="product.model"
ng-change='change()' tooltip="Ex:RA-R436"
tooltip-placement="right" id="productModel"/>
</div>
<div class="form-group">
<label for="productUrl"> Product URL: </label>
<input type="url" placeholder="http://shop.reelyactive.com/products/ra-r436"
class="form-control" ng-model="product.url"
ng-change='change()' id="productUrl"/>
</div>
<div class="form-group">
<label for="imageUrl"> Image URL: </label>
<input type="url" placeholder="http://reelyactive.com/products/ra-r436/portrait.jpg"
class="form-control" ng-model="product.image"
ng-change='change()' id="imageUrl"/>
</div>
</form>
</div>
<div class="col-xs-12 col-md-7">
<pre>{{json | json}}</pre>
<p class="text-center">
<button class="btn btn-primary" ng-click="$ctrl.webify()">
Export to web
</button>
</p>
</div>
</div>
<h3> Confirm the product representation </h3>
<p> Did it work? Check by entering the URL of your product webpage below and pressing the button to attempt to fetch the code. </p>
<form class="form-inline">
<div class="form-group">
<label for="url">Product URL</label>
<input type="url" class="form-control" id="url" ng-model="url"
placeholder="http://myproduct.info">
</div>
<button type="submit" class="btn btn-default"
ng-click="fetchStory(url)">Fetch</button>
</form>
<br>
<pre ng-show="fetchedStory"> {{fetchedStory}} </pre>
<h3> <i>Alternative:</i> represent your Organization </h3>
<p> If your organization has multiple products which share the same identifier (ex: <a href="https://www.bluetooth.com/specifications/assigned-numbers/company-identifiers" target="_blank">Bluetooth Company Identifier</a>), consider instead a <a href="http://schema.org/Organization" target="_blank">schema:Organization</a> representation. </p>
<hr>
<p><br><br></p>
<a id="association"></a>
<img src="images/product-sniffypedia.png"
class="img-responsive center-block">
<h2> Association <br>
<small> Your product identifier needs to be associated with its representation. </small> </h2>
<p> Our platform references the <a href="http://sniffypedia.org/" target="_blank">Sniffypedia project</a>, which allows anyone to contribute structured data about products and their associated identifiers. Anyone can contribute a product to Sniffypedia, requiring only: </p>
<ul>
<li> the <a href="#identification">identifier</a> type and value
<li> the URL of the product <a href="#representation">representation</a>
</ul>
</p>
<p> If you've successfully represented your product but are unable to contribute to Sniffypedia, contact us with the <i>identifier</i> and <i>URL</i> and we'll update the index. </p>
<p class="text-center">
<a href="https://sniffypedia.org/contribute/" target="_blank"
class="btn btn-default"> Contribute to Sniffypedia </a>
<a href="http://www.reelyactive.com/contact/" target="_blank"
class="btn btn-default"> Contact reelyActive </a>
</p>
<p> Our open source <a href="https://www.npmjs.com/package/chickadee" target="_blank">chickadee</a> package will immediately recognise the product via a Sniffypedia lookup. And our Pareto platform always integrates the latest Sniffypedia index for your convenience. </p>
<img src="images/pareto-by-reelyactive.jpg"
class="img-responsive center-block"><br>
<p class="text-center">
<a class="btn btn-primary" href="https://getpareto.com"
target="_blank" role="button"> Visit getpareto.com </a>
</p>
<hr>
<h2> What's next? </h2>
<p> Alternatively, consider having your product broadcast an <a href="https://github.com/google/eddystone/tree/master/eddystone-url" target="_blank">Eddystone-URL</a> packet. In this case the association is implicit and no additional integration with our platform is required! </p>
<p class="text-center">
<a class="btn btn-default" href="integrate-your-service.html"
role="button"> Integrate your Service </a>
<a class="btn btn-default" href="integrate-your-mobile-app.html"
role="button"> Integrate your Mobile App </a>
<a class="btn btn-success" href="index.html"
role="button"> Return to diyActive </a>
</p>
</div>
<div class="col-xs-0 col-sm-1 col-md-2 col-lg-3"></div>
</div>
</div>
<footer class="footer">
<a href="/"> diyActive </a> |
<a href="https://www.reelyactive.com">
© reelyActive 2016-2018
</a>
</footer>
</div>
<!----- Start Modal ----->
<script type="text/ng-template" id="export.html">
<div class="modal-header">
<h3 class="modal-title">
Structured data for the web
</h3>
</div>
<div class="modal-body">
<p> Copy the following markup into either the head or body of the product webpage: </p>
<pre>{{markup}}</pre>
<p class="text-right"> This is great for search engine optimisation (SEO) too! </p>
</div>
<div class="modal-footer">
<button class="btn btn-primary" type="button"
ng-click="$ctrl.ok()"> Dismiss </button>
</div>
</script>
<!----- End Modal ----->
</body>
</html>