summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 0a89087c34e1ac57cfd0727abe13cb7bfc36331d (plain)
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
# NFC Service

## Overview

NFC service uses the respective libnfc package to detect the presence of NFC tags and singal via an event

## Verbs

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

## Events

### libnfc response

| Name               | Description                          | JSON Response                                                          |
|--------------------|:-------------------------------------|:-----------------------------------------------------------------------|
| presence           | event that reports NFC tag presence  |  *Response:* {"status": "detected", "uid": "042eb3628e4981"}           |


### 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" } }  |