https://github.com/zonque/nfceyboard

Simple Arduino based NFC-enabled key-board
https://github.com/zonque/nfceyboard

esp8266 home-automation iot-device nfc

Last synced: 13 days ago
JSON representation

Simple Arduino based NFC-enabled key-board

• Host: GitHub
• URL: https://github.com/zonque/nfceyboard
• Owner: zonque
• Created: 2018-11-05T20:01:51.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-06T12:43:11.000Z (over 6 years ago)
• Last Synced: 2024-11-30T20:34:01.366Z (2 months ago)
• Topics: esp8266, home-automation, iot-device, nfc
• Language: C++
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NFCeyboard

This project implements the firmware for a simple key-board that reads NFC tags

attached to key ring and reports their presence to an MQTT server. Multiple MFRC522

based, SPI connected NFC readers are supported.

## Operation

The firmware polls for NFC tags on each reader once per second. If a tag is not seen

for `NfcTagTimeoutSeconds` (5) seconds, it is reported as `away` in the MQTT broker.

When it is seen, the topic is set to `home`.

## Configuration

Before building the project, copy `src/config.h.template` to `src/config.h` and fill in

the following details.

* The Wifi SSID and passphrase

* The MQTT server to connect to

* The NFC tags to listen to, along with the MQTT topic to use for reporting

* The SS (chip-select) pins for each MFRC522 reader

## Building the software

The project is implemented with PlatformIO. Please make sure to use a PlatformIO enabled

environment when compiling.

## Hardware wiring

The firmware is compatible to ESP8266 boards. To interface the NFC readers, connect them

to the SPI pins of the hardware so that they all share the `MISO`, `MOSI` and `CLK` lines,

along with `VCC` (3.3V) and `GND`. Each NFC reader needs to be connected to a dedicated `SS`

(chip-select) line. The configuration in `config.h` needs to specify these chip-select pins.

## HomeAssistant

As the firmware communicates with its environment via an MQTT server, it can be easily

integrated into HomeAssistant installations.

Add your MQTT broker to `configuration.yaml`. For instance:

```yaml

mqtt:

  broker: localhost

```

And then add a device for each tag that was configured in the firmware. For instance:

```yaml

notify:

- platform: mqtt

  devices:

    foo_key: 'key/foo'

```

For more information, refer to the [HomeAssistant MQTT documentation](https://www.home-assistant.io/components/device_tracker.mqtt/).