summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 506d984259ac570da424aea111f1564dcc8dfa6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# NFC Service

## Overview

NFC service uses neard package to detect the presence of NFC tags and signal clients via an event.
The presence event shall include a dictionary named "record" that contains entries with a "Type"
field and a value field named after the "Type" value.

## Verbs

| Name               | Description                          | JSON Parameters                                                        |
|--------------------|:-------------------------------------|:-----------------------------------------------------------------------|
| subscribe          | subscribe to NFC events              | *Request:* {"value": "presence"}                                       |
| unsubscribe        | unsubscribe to NFC events            | *Request:* {"value": "presence"}                                       |

## Events
### neard response

| Name               | Description                          | JSON Response                                                          |
|--------------------|:-------------------------------------|:-----------------------------------------------------------------------|
| presence           | event that reports NFC tag presence  |  *Response:* {"status": "detected",                                    |
|                    |                                      |      "record": { "Type": "URI", "URI": "http://www.nfc-forum.com" } }  |