lib

README

uhppoted-lib

Shared library that implements the functionality common to multiple uhppoted sub-projects. In particular:

• conf file marshaling
• ACL (access control lists)
• TSV encoding and decoding
• Wrapper functions for the rest and MQTT services to facilitate invoking controller functions on multiple devices.

Release Notes

Current Release

v0.8.8 - 2024-03-26

1. RestoreDefaultParameters API function to reset controller to manufacturer default configuration.
2. Bumped Go version to 1.22

Development

Building from source

Assuming you have Go and make installed:

git clone https://github.com/uhppoted/uhppoted-lib.git
cd uhppoted-lib
make build

If you prefer not to use make:

git clone https://github.com/uhppoted/uhppoted-lib.git
cd uhppoted-lib
mkdir bin
go build -trimpath -o bin ./...

Dependencies

Dependency	Description
uhppote-core	Device level API implementation
golang.org/x/sys	Support for Windows services

Documentation

Overview

Package uhppoted-lib implements the functionality common to most applications that use uhppote-core.

The package is a library package that is intended to simplify the common tasks associated with writing applications that interface to the UHPPOTE access controllers but that do not form part of the core API, viz.: - configuration - command line arguments - access control lists - internationalisation - lock files - logging - monitoring

Structure

The library consists of the following packages:

• uhppoted-lib/uhppoted which wraps certain uhppote-core functionality that typically requires an extended interchange with the access controller e.g. retrieving card lists or events.
• uhppoted-lib/conf which manages the common configuration file uhppoted.conf.
• uhppoted-lib/command which defines the common 'help' and 'version' commands along with helper functions for command line parsing.
• uhppoted-lib/acl which implements the commonly required access control list management functionality.
• uhppoted-lib/log which implements the common logging format used by other uhppoted modules.
• uhppoted-lib/lockfile which implements the lockfiles used to ensure single active instances of an application.
• uhppoted-lib/monitoring which implements the system health and watchdog functionality.