Skip to content

Simple to build/use NFC tag reader, specially created for Home Assistant

License

Notifications You must be signed in to change notification settings

magnusoverli/tagreader-1

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tag Reader for Home Assistant

The tag reader is a simple to build/use NFC tag reader, specially created for Home Assistant. It is using a Wemos D1 and the PN532 NFC module. The firmware is built using ESPhome.

I am selling a pre-built version, a DIY version (assembly required) or just the case (use with own components). Check it out on my website.

Photos of the final product

Building the tag reader

To build your own tag reader, you need the following components:

The 3D models for the case are here.

Connecting the components

Photo of schematics

There are not too many components to connect, but it does require soldering. You will need the following:

To flash the reader firmware to your D1 Mini you point ESPHome at tagreader.yaml. If you're new to ESPHome, we recommend that you use the ESPHome Home Assistant add-on.

Open Case

Configuring for use with Home Assistant

If the tag reader is unable to connect to a wifi network, it will start a WiFi access point with a captive portal to allow you to enter your WiFi credentials.

The tag reader will be automatically found by Home Assistant once the tag reader is connected to the same network. You can follow the instructions in the UI to set it up.

A custom component is required for Home Assistant at this time to link the tag reader to the tag integration in Home Assistant. Copy this file to <config>/custom_components/esphome_tag.py and add esphome_tag: to your configuration.yaml file.

Usage

Each tag that is scanned will result in a tag_scanned event in Home Assistant. You can manage your tags and automate them in the Home Assistant UI under config -> tags.

Screenshot of the Home Assistant tag UI

Contributing

TODO

About

Simple to build/use NFC tag reader, specially created for Home Assistant

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%