Skip to main content

A webserver that connects to a acr122u and exposes it over websocket

Project description

ACR122U Websocket

PyPI - Version PyPI - License PyPI - Downloads PyPI - Python Version PyPI - Wheel

This project enables you to connect an usb ACR122U NFC card scanner to a computer and access it using Socket.IO.

Features

  • Read UUID from nfc cards and send them over Socket.IO.
  • Websocket messages to start and stop the polling for cards.
  • Websocket messages to give a confirmation or error beep and light signal.
  • Automatically reconnect to the reader when interrupted.

Installation

You can install this package from PyPI.

pip install acr122u-websocket

Usage

  1. Connect the ACR122U reader to the computer
  2. Run the app
    python -m acr122u_websocket.app
    

API

You can connect to the webserver using Socket.IO. These are the available events:

polling

Start or stop the polling.

Request

  • start to start the polling.
  • stop to stop the polling.

Reply

  • no card reader connected if no card reader is connected.
  • polling started if the polling has (already) started.
  • polling stopped if the polling has (already) stopped.
  • invalid message if the message is neither start nor stop.

status indicator

Set the status indicator.

Request

  • confim to play the confirming status.
  • error to play the error status.

Reply

  • no card reader connected if no card reader is connected
  • confirm status set if the confirm beep and light have been show
  • error status set if the error beep and light have been show
  • invalid message if the message is neither confirm nor error

card scanned

Broadcasts when a card has been scanned

Broadcast

  • {"uuid": [..]} - An object containing the uuid in the form of a list of integers.

Example

See an example webpage at test.html.

This page is also served on http://localhost:8080/test.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acr122u-websocket-1.1.4.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

acr122u_websocket-1.1.4-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file acr122u-websocket-1.1.4.tar.gz.

File metadata

  • Download URL: acr122u-websocket-1.1.4.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for acr122u-websocket-1.1.4.tar.gz
Algorithm Hash digest
SHA256 91247579f5b6b5b1de35db4e3b8a5914a951a6287285580f327083084087ad8a
MD5 86a79fd94089b62fcdf6bcfb37a54d90
BLAKE2b-256 b7c2df05090eb908f6d3c48aea21c39b9a1dfc3f16a30842a29e7ba20d42e092

See more details on using hashes here.

File details

Details for the file acr122u_websocket-1.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for acr122u_websocket-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ba1ed1d05315f52b984d11384fe11fe28a23c5720eefc59bbf5e6fcf5fb946fe
MD5 778ab469b7122a88335c06ca1c1102bd
BLAKE2b-256 f0663c4bd4f00ebc2432f32a88d54634201fdeb1b115b47c7aa6d750efa94eee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page