README
¶
uhppote-simulator
Software simulator for access control systems based on the UHPPOTE UT0311-L0x TCP/IP Wiegand access control boards.
Supported operating systems:
- Linux
- MacOS
- Windows
- ARM7 (RaspberryPi)
Releases
| Version | Description |
|---|---|
| v0.8.1 | Maintenance release for version compatibility with uhppote-core v0.8.1 |
| v0.8.0 | Maintenance release for version compatibility with uhppote-core v0.8.0 |
| v0.7.3 | Maintenance release for version compatibility with uhppote-core v0.7.3 |
| v0.7.2 | Replaced event list rollover to discard a 'chunk' of events when the list is full |
| v0.7.1 | Added support for task list functionality from the extended API |
| v0.7.0 | Added support for time profiles from the extended API |
| v0.6.12 | Added simulation support for encoding nil events for response to get-status |
| v0.6.10 | Maintenance release for version compatibility with uhppoted-app-wild-apricot |
| v0.6.8 | Implements firmware UHPPOTE v6.62 event message format |
| v0.6.7 | Implements record-special-events and door open, close and button actions and events |
| v0.6.5 | Maintenance release for version compatibility with node-red-contrib-uhppoted |
| v0.6.4 | Maintenance release for version compatibility with uhppoted-app-sheets |
| v0.6.3 | Reworked card list as fixed length array and emulated deleted records |
| v0.6.2 | Updated simulation response for 'no events' |
| v0.6.1 | Maintenance release to update module dependencies |
| v0.6.0 | Maintenance release to update module dependencies |
| v0.5.1 | Initial release following restructuring into standalone Go modules and git submodules |
Installation
Building from source
Assuming you have Go and make installed:
git clone https://github.com/uhppoted/uhppote-simulator.git
cd uhppote-simulator
make build
If you prefer not to use make:
git clone https://github.com/uhppoted/uhppote-simulator.git
cd uhppote-simulator
mkdir bin
go build -trimpath -o bin ./...
Dependencies
| Dependency | Description |
|---|---|
| uhppote-core | Device level API implementation |
uhppote-simulator
Supported uhppote functions:
- FindDevices
- FindDevice
- SetAddress
- GetListener
- SetListener
- GetTime
- SetTime
- GetDoorControlState
- SetDoorControlState
- RecordSpecialEvents
- GetStatus
- GetCards
- GetCardById
- GetCardByIndex
- PutCard
- DeleteCard
- DeleteCards
- GetTimeProfile
- SetTimeProfile
- ClearTimeProfiles
- ClearTaskList
- AddTask
- RefreshTaskList
- GetEvent
- GetEventIndex
- SetEventIndex
- OpenDoor
- Listen
Supported actions:
- swipe card
- press button
- open door
Usage: uhppote-simulator <command> --devices=<dir>
Defaults to 'run' unless one of the commands below is specified:
- help
- version
Supported options:
- --bind
- --devices
- --debug
NOTES
Events
tl;dr; The UHPPOTE controller does not 'rollover' when the onboard event store is filled.
From experimentation, it appears that the UHPPOTE controller has an event store for approximately 200 000 events (possibly varies varies with model/version). On filling the event buffer the controller seems to discard a chunk of about 2048 events from the start of the event buffer to make space for new events. The event index continues to increment monotonically.
Directories