https://github.com/digibib/go-feig

https://github.com/digibib/go-feig

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/digibib/go-feig
• Owner: digibib
• License: mit
• Archived: true
• Created: 2017-08-01T08:32:06.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T09:49:02.000Z (almost 2 years ago)
• Last Synced: 2025-03-06T09:49:15.338Z (over 1 year ago)
• Language: Go
• Size: 73.2 KB
• Stars: 0
• Watchers: 10
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

          
# Feig RFID integration

Feig RFID hardware integration and API for simple implentation and control.

This software is released under MIT license from Deichman Public Library.

Short description: This is a service that exposes a simple API to communication with FEIG hardware, either connected by USB, Serial or TCP.

It encompasses the operations to read and write tags and AFI alarm on ISO15693 transponders using a FEIG device. It also wraps an HTTP eventsource

endpoint for easy use by any browser app. In addition it allows for embedding any HTTP web page if included under ``./cmd/html` folder.

## Installation and Requirements

go version 1.19 or later is required, as well as `make` and FEIG SDK drivers and header files for the expected system to run on (windows / linux 64bit or Raspberry PI).

Header files `feusb.h` etc. need to be placed under `drivers` or in system header folders.

Drivers need to be included under `drivers/` or in system driver folders.

To build, e.g. for windows: run `make build_windows`

## Usage

```

  -debug

    	turn on verbose logging

  -port string

    	port of http API (default ":1666")

  -library string

        the ISIL number of the library (exclusive country code)

  -wake

    	Keep inventory state and keep all transponders awake (default true)

  -axeHost

        host ip/name of a TCP connected Feig Axe in same network

  -axePort

        port of a TCP connected Feig Axe in same network

```

Application fires up a http server and mounts optional web content from ./html folder

**API routes:**

```

    /.status 	server status endpoint

    /events/    eventsource subscription

    /scan    	scan inventory once

    /start 		start scan loop (send to any connected EventSource client)

    /stop 		stop scan loop

    /write 		write to tags in range (param: barcode)

    /writetagbarcode  write to a single tag in current inventory (params: tagid, barcode)

    /alarmOff 	turn off AFI alarm on all tags in range

    /alarmOn 	turn on AFI alarm on all tags in range

```

Basic flow is:

* inventory is fetched and kept in memory either by polling `/scan` or by activating scan loop with `/start`

* barcodes can be used to fetch and present information, e.g. from spore

* at any time a current inventory can be

    * rewritten: all tags in range are written to using sequence number and number of tags (`/write?barcode=1234567890`)

    * desensitized: (`/alarmOff`)

    * sensitized: (`/alarmOn`)

* `/.status` will at any time display uptime status, current inventory and read success/failures

## Documentation

Read more in ./docs folder