Shared library (DLL) for uhppote-core with bindings and examples for:
3rd party bindings:
Supported operating systems:
- Linux
- MacOS
- Windows
- RaspberryPi (ARM7)
The releases do not include binaries - cross-compiling a DLL/shared-lib is not simple because the cgo compiler links in a platfrom specific version of glibc. Building the DLL/shared-lib is straightforward (see below) and only requires that go and cgo are installed on the system.
v0.8.10 - 2025-01-30
- Added event auto-send interval to the
get-listenerandset-listenerAPIs.
Requirements:
- Go v1.23+
- (Windows only) mingw
- (optional) make
The DLL/shared lib/dylib has to be built from source:
git clone https://github.com/uhppoted/uhppoted-dll.git
cd uhppoted-dll
make build
If you prefer to build manually:
git clone https://github.com/uhppoted/uhppoted-dll.git
cd uhppoted-dll
go build -trimpath -buildmode=c-shared -o <lib> go/devices.go go/cards.go go/events.go go/time_profiles.go go/tasks.go go/main.go
NOTE: The list of source files is required pending a fix for cmd/cgo: inconsistent compiler behaviour when compilin 8000 g a C.struct_
Copy the generated DLL (Windows), shared lib (Linux) or dylib (MacOS) to the library search path for the platform:
- LD_LIBRARY (Linux)
- DYLIB_LIBRARY (MacOS)
- Windows - see Dynamic-Link Library Search Order
- (OR) to the same folder as the project executable.
The usage for the language specfic bindings are described in their own documents:
The debug shared-lib/DLL displays the parameters with which the function was invoked. It fakes the call
to the real controller, returning a plausible response instead.
The test shared-lib/DLL is included for integration testing and validates that the parameters with which a
function is invoked match expected values. As with the debug lib, it does not access a real controller and
returns a fixed response.
| Dependency | Description |
|---|---|
| uhppote-core | Device level API implementation |
| uhppoted-lib | Library of commonalised functionality |
GetDevicesGetDeviceSetAddressGetListenerSetListenerGetTimeSetTimeGetDoorControlStateSetDoorControlStateOpenDoorGetStatusGetCardsGetCardGetCardByIndexPutCardDeleteCardDeleteCardsGetEventGetEventIndexSetEventIndexRecordSpecialEventsGetTimeProfileSetTimeProfileClearTimeProfilesClearTaskListAddTaskRefreshTaskListSetPCControlSetInterlockActivateKeypadsSetDoorPasscodesGetAntiPassbackSetAntiPassbackRestoreDefaultParametersListen
Retrieves a list of all UHPPOTE controllers that respond to a broadcast get-device request.
Retrieves the controller information for a specific UHPPOTE controller from the response to a get-device request.
Sets the IPv4 address, subnet mask and gateway address for a controller.
Retrieves the controller configured event listener IPv4 address:port and (optionally) the auto-send interval.
Sets the controller event listener IPv4 address:port and the auto-send interval.
Retrieves the controller date and time.
Sets the controller date and time.
Retrieves a door control state (normally open, normally closed or controlled) from the controller.
Sets a door control state (normally open, normally closed or controlled) on the controller.
Unlocks a door remotely.
Retrieves the controller current status.
The controller status includes the most recently logged event but if the controller has no events
the Event field will have an index of 0 and all the other fields will be invalid.
Retrieves the number of cards stored on a controller.
Retrieves a stored card's information using the card number.
Retrieves a stored card's information using an index into the card list.
Adds or updates a card record on the controller.
Note: The UHPPOTE access controller has a weird behaviour around the PIN field. According to the SDK documentation, valid PINs are in the range 0 to 999999. However the controller will accept a PIN number out of that range and only keep the lower 7 nibbles of the 32-bit unsigned value. e.g:
| PIN | Hex value | Stored as (hex) | Retrieved as (hex) | Retrieved as (decimal) |
|---------|-----------|-----------------|--------------------|------------------------|
| 0 | 0x000000 | 0x000000 | 0x000000 | 0 |
| 999999 | 0x0f423f | 0x0f423f | 0x0f423f | 999999 |
| 1000000 | 0x0f4240 | 0x000000 | 0x000000 | 0 |
| 1000001 | 0x0f4241 | 0x000000 | 0x000000 | 0 |
| 1048576 | 0x100000 | 0x000000 | 0x000000 | 0 |
| 1048577 | 0x100001 | 0x000000 | 0x000001 | 1 |
| 1999999 | 0x1E847F | 0x0E847F | 0x000001 | 951423 |
Like the _uhppote-core_ `put-card` implementation, the DLL implemenation returns an error
for an out of range PIN.
Deletes a card record from the controller.
Deletes all card records from the controller.
Retrieves a single stored event (by index) from the controller.
Retrieves the current value of the controller event index (typically used as a marker for events that have been retrieved).
Sets the current value of the controller event index (typically used to update the marker for events that have been retrieved).
Enables or disables the door and relay events on a controller.
Retrieves a numbered time profile from the controller.
Adds or updates a numbered time profile on the controller.
Deletes all stored time profiles from a controller.
Clears the scheduled task list on a specific UHPPOTE controller, preparatory to using AddTask and RefreshTask.
Adds a scheduled task to the task list on a specific UHPPOTE controller. The task is not activated until RefreshTaskList is invoked. ClearTaskList should have been invoked prior to invoking a sequence of AddTask invocations to put the task list in a known state.
Activates all tasks added by AddTask.
Enables or disables remote host access control.
If remote host access control is enabled, the access controller expects the host to communicate at least once every 30 seconds otherwise it reverts to local control of access using the stored list of cards (the communication is not required to be a 'set-pc-control' command - any command is sufficient). If the access controller has reverted to local control because no message has been received from the host for more than 30 seconds, any subsequent communication from the remote host will re-establish remote control mode again.
Sets a controller door interlock.
The door interlock prevents a door from opening unless the interlock condition is valid for that door. The API takes a byte value as the interlock mode, corresponding to one of the following modes:
| Value | Mode | Description |
|---|---|---|
| 0 | none | Any door can opened subject to access restrictions |
| 1 | 1&2 | Door 1 can be opened if 2 is closed and vice versa, doors 3 and 4 are not interlocked |
| 2 | 3&4 | Door 3 can be opened if 4 is closed and vice versa, doors 1 and 2 are not interlocked |
| 3 | 1&2,3&4 | Door 1 can be opened if 2 is closed and vice versa. Door 3 can be opened if 4 is closed (and vice versa) |
| 4 | 1&2&3 | Door 1 can be opened if 2 and 3 are both closed, door 2 if 1 and 3 are closed and door 3 if 1 and 2 are closed |
| 8 | 1&2&3&4 | A door can only be opened if all the other doors are closed |
Activates and deactivates a controller reader access keypads.
Note that the controllers do not provide the capability for activating or deactivating individual keypads.
Sets up to four supervisor passcodes to allow keypad only access to a door.
Gets the controller anti-passback mode. The anti-passback will be one of the following:
- disabled
- (1:2);(3:4)
- (1,3):(2,4)
- 1:(2,3)
- 1:(2,3,4)
| Value | Mode | Description |
|---|---|---|
| 0 | disabled | No anti-passback |
| 1 | (1:2);(3:4) | Doors 1 and 2 are interlocked, doors 3 and 4 are interlocked |
| 2 | (1,3):(2,4) | Doors 1 and 3 are interlocked with doors 2 and 4 |
| 3 | 1:(2,3) | Door 1 is interlocked with doors 2 and 3 |
| 4 | 1:(2,3,4) | Door 1 is interlocked with doors 2,3 and 4 |
where interlocked means a card will be swiped through a second time on a door until it has been swiped through at the interlocked door. e.g: if the anti-passback mode is _(1,3):(2,4), a card swiped through at either of doors 1 or 3 will be denied access at doors 1 and 3 until it has been swiped through at either of doors 2 or 4. Likewise a card swiped through at either of doors 2 or 4 will be denied access at doors 2 and 4 until is has been swiped through at either of doors 1 or 3.
Sets the controller anti-passback mode. The anti-passback must be one of the following:
- disabled
- (1:2);(3:4)
- (1,3):(2,4)
- 1:(2,3)
- 1:(2,3,4)
| Value | Mode | Description |
|---|---|---|
| 0 | disabled | No anti-passback |
| 1 | (1:2);(3:4) | Doors 1 and 2 are interlocked, doors 3 and 4 are interlocked |
| 2 | (1,3):(2,4) | Doors 1 and 3 are interlocked with doors 2 and 4 |
| 3 | 1:(2,3) | Door 1 is interlocked with doors 2 and 3 |
| 4 | 1:(2,3,4) | Door 1 is interlocked with doors 2,3 and 4 |
where interlocked means a card will be swiped through a second time on a door until it has been swiped through at the interlocked door. e.g: if the anti-passback mode is _(1,3):(2,4), a card swiped through at either of doors 1 or 3 will be denied access at doors 1 and 3 until it has been swiped through at either of doors 2 or 4. Likewise a card swiped through at either of doors 2 or 4 will be denied access at doors 2 and 4 until is has been swiped through at either of doors 1 or 3.
Resets a controller to the manufacturer default configuration.
Listens for controller events and forwards received events to a callback function for processing by the application.