.NET package for the UHPPOTE UT0311-L0x* TCP/IP Wiegand access controller API.
The API is described in detail in the API documentation and examples in F#, C# and VB.NET are included to illustrate the use of the API.
v0.8.10 - 2025-01-30
- Initial release.
The package can be installed from either the NuGet registry or Github Packages:
Use either the dotnet CLI or Package Manager:
- CLI:
dotnet add package uhppoted --version 0.8.10
- Package Manager (console):
NuGet\Install-Package uhppoted -Version 0.8.10
After installing the package it should be referenced in the project file, e.g.:
...
<ItemGroup>
<PackageReference Include="uhppoted" Version="0.8.10" />
</ItemGroup>
...
Installing from the Github Packages NuGet registry requires a Personal Access Token (classic)
with at least package: read permissions.
-
dotnet CLI:
dotnet nuget add source --username <username> --password <personal-access-token> --store-password-in-clear-text --name uhppoted "https://nuget.pkg.github.com/uhppoted/index.json" dotnet nuget add source https://nuget.pkg.github.com/uhppoted/index.json dotnet add package uhppoted --version 0.8.10 -
Package Manager (console):
NuGet\Set-Source -Name "uhppoted" -Source "https://nuget.pkg.github.com/uhppoted/index.json" -Username "<username>" -Password "<personal-access-token>" NuGet\Install-Package uhppoted -Version 0.8.10
After installing the package it should be referenced in the project file, e.g:
...
<ItemGroup>
<PackageReference Include="uhppoted" Version="0.8.10" />
</ItemGroup>
...
Requirements:
- .NET SDK 7.0+
- (optional) make
git clone https://github.com/uhppoted/uhppoted-lib-dotnet.git
cd uhppoted-lib-dotnet/uhppoted
make build
If you prefer to build without make:
git clone https://github.com/uhppoted/uhppoted-lib-dotnet.git
cd uhppoted-lib-dotnet/uhppoted
dotnet build
C# applications may additionally require installing the FSharp.Core package:
dotnet add package FSharp.Core
VB.NET applications may additionally require installing the FSharp.Core package:
dotnet add package FSharp.Core
Discovers all controllers accessible via a UDP broadcast on the local LAN.
Retrieves the IPv4 configuration, MAC address and version information for an access controller.
Sets a controller IPv4 address, netmask and gateway address.
Gets a controller event listener address:port and auto-send interval.
Sets a controller event listener endpoint and auto-send interval.
Gets a controller current date and time.
Sets a controller current date and time.
Gets a controller door operational mode and unlocked delay.
Sets a controller door operational mode and unlocked delay.
Sets up to 4 passcodes for a controller door.
Unlocks a door controlled by a controller.
Retrieves a controller status and most recent event (if any).
Retrieves the number of card records stored on a controller.
Retrieves a card record by card number.
Retrieves the card record (if any) at the index from a controller.
Adds or updates a card record on a controller.
Deletes a card record from a controller.
Deletes all card records from a controller.
Retrieves the event record (if any) at the index from a controller.
Retrieves the current event index from a controller.
Sets a controller event index.
Enables (or disables) events for door open/close, button press, etc.
Retrieves an access time profile from a controller.
Adds or updates an access time profile on a controller.
Clears all access time profiles stored on a controller.
Adds or updates a scheduled task on a controller.
Clears all scheduled tasks from a controller tasklist.
Schedules added tasks.
Enables/disables remote access control management.
Sets the door interlock mode for an access controller.
Activates/deactivates the access reader keypads attached to an access controller.
Gets a controller anti-passback mode.
Sets a controller anti-passback mode.
Restores the manufacturer default settings.
Listens for access controller events.
As per Microsoft Knowledgebase Article 929851,
the default Windows ephemeral port range extends from 49152 to 65535, which includes the default UHPPOTE UDP port (60000). Present-day BSD and Linux
have similar ranges.
If an application is assigned port 60000 when binding to e.g. 0.0.0.0:0 it will receive the any outgoing UDP broadcast requests and interpret
them as replies - which will be, uh, a little confusing, e.g.:
request:
17 94 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
reply:
17 94 00 00 78 37 2a 18 c0 a8 01 64 ff ff ff 00
c0 a8 01 01 00 12 23 34 45 56 08 92 20 18 11 05
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
get-all-controllers:
controller: 0
address: 0.0.0.0
netmask: 0.0.0.0
gateway: 0.0.0.0
MAC: 00:00:00:00:00:00
version: v0.00
date: ---
controller: 405419896
address: 192.168.1.100
netmask: 255.255.255.0
gateway: 192.168.1.1
MAC: 00:12:23:34:45:56
version: v8.92
date: 2018-11-05
In general this doesn't seem to have been a problem (or at least nobody has raised it as an issue) and the implementation will return an error if the bind port for a UDP broadcast is 60000. It can be mitigated by:
- Excluding port
60000from the ephemeral range using whatever method is recommended for your platform of choice. - (OR) Reduce (or move) the ephemeral port range (again using whatever method is recommended for your platform of choice).
- (OR) (really not recommended except as a quick hack) Bind a netcat listener to port
60000before running the application:
nc -lu 600000
References: