Documentation
¶
Index ¶
- type ActivateAccessKeypadsRequest
- type ActivateAccessKeypadsResponse
- type AddTaskRequest
- type AddTaskResponse
- type ClearTaskListRequest
- type ClearTaskListResponse
- type ClearTimeProfilesRequest
- type ClearTimeProfilesResponse
- type DeleteCardRequest
- type DeleteCardResponse
- type DeleteCardsRequest
- type DeleteCardsResponse
- type Event
- type EventV6_62
- type GetCardByIDRequest
- type GetCardByIDResponse
- type GetCardByIndexRequest
- type GetCardByIndexResponse
- type GetCardsRequest
- type GetCardsResponse
- type GetDeviceRequest
- type GetDeviceResponse
- type GetDoorControlStateRequest
- type GetDoorControlStateResponse
- type GetEventIndexRequest
- type GetEventIndexResponse
- type GetEventRequest
- type GetEventResponse
- type GetListenerRequest
- type GetListenerResponse
- type GetStatusRequest
- type GetStatusResponse
- type GetTimeProfileRequest
- type GetTimeProfileResponse
- type GetTimeRequest
- type GetTimeResponse
- type OpenDoorRequest
- type OpenDoorResponse
- type PutCardRequest
- type PutCardResponse
- type RecordSpecialEventsRequest
- type RecordSpecialEventsResponse
- type RefreshTaskListRequest
- type RefreshTaskListResponse
- type Request
- type Response
- type RestoreDefaultParametersRequest
- type RestoreDefaultParametersResponse
- type SetAddressRequest
- type SetDoorControlStateRequest
- type SetDoorControlStateResponse
- type SetDoorPasscodesRequest
- type SetDoorPasscodesResponse
- type SetEventIndexRequest
- type SetEventIndexResponse
- type SetFirstCardRequest
- type SetFirstCardResponse
- type SetInterlockRequest
- type SetInterlockResponse
- type SetListenerRequest
- type SetListenerResponse
- type SetPCControlRequest
- type SetPCControlResponse
- type SetTimeProfileRequest
- type SetTimeProfileResponse
- type SetTimeRequest
- type SetTimeResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActivateAccessKeypadsRequest ¶ added in v0.8.6
type ActivateAccessKeypadsResponse ¶ added in v0.8.6
type ActivateAccessKeypadsResponse struct { MsgType types.MsgType `uhppote:"value:0xA4"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type AddTaskRequest ¶ added in v0.7.1
type AddTaskRequest struct { MsgType types.MsgType `uhppote:"value:0xa8"` SerialNumber types.SerialNumber `uhppote:"offset:4"` From types.Date `uhppote:"offset:8"` To types.Date `uhppote:"offset:12"` Monday bool `uhppote:"offset:16"` Tuesday bool `uhppote:"offset:17"` Wednesday bool `uhppote:"offset:18"` Thursday bool `uhppote:"offset:19"` Friday bool `uhppote:"offset:20"` Saturday bool `uhppote:"offset:21"` Sunday bool `uhppote:"offset:22"` Start types.HHmm `uhppote:"offset:23"` Door uint8 `uhppote:"offset:25"` Task uint8 `uhppote:"offset:26"` MoreCards uint8 `uhppote:"offset:27"` }
type AddTaskResponse ¶ added in v0.7.1
type AddTaskResponse struct { MsgType types.MsgType `uhppote:"value:0xa8"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type ClearTaskListRequest ¶ added in v0.7.1
type ClearTaskListRequest struct { MsgType types.MsgType `uhppote:"value:0xa6"` SerialNumber types.SerialNumber `uhppote:"offset:4"` MagicWord uint32 `uhppote:"offset:8"` }
type ClearTaskListResponse ¶ added in v0.7.1
type ClearTaskListResponse struct { MsgType types.MsgType `uhppote:"value:0xa6"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type ClearTimeProfilesRequest ¶ added in v0.7.0
type ClearTimeProfilesRequest struct { MsgType types.MsgType `uhppote:"value:0x8a"` SerialNumber types.SerialNumber `uhppote:"offset:4"` MagicWord uint32 `uhppote:"offset:8"` }
type ClearTimeProfilesResponse ¶ added in v0.7.0
type ClearTimeProfilesResponse struct { MsgType types.MsgType `uhppote:"value:0x8a"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type DeleteCardRequest ¶
type DeleteCardRequest struct { MsgType types.MsgType `uhppote:"value:0x52"` SerialNumber types.SerialNumber `uhppote:"offset:4"` CardNumber uint32 `uhppote:"offset:8"` }
type DeleteCardResponse ¶
type DeleteCardResponse struct { MsgType types.MsgType `uhppote:"value:0x52"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type DeleteCardsRequest ¶
type DeleteCardsRequest struct { MsgType types.MsgType `uhppote:"value:0x54"` SerialNumber types.SerialNumber `uhppote:"offset:4"` MagicWord uint32 `uhppote:"offset:8"` }
type DeleteCardsResponse ¶
type DeleteCardsResponse struct { MsgType types.MsgType `uhppote:"value:0x54"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type Event ¶ added in v0.6.8
type Event struct { MsgType types.MsgType `uhppote:"value:0x20"` SerialNumber types.SerialNumber `uhppote:"offset:4"` EventIndex uint32 `uhppote:"offset:8"` EventType byte `uhppote:"offset:12"` Granted bool `uhppote:"offset:13"` Door byte `uhppote:"offset:14"` Direction uint8 `uhppote:"offset:15"` CardNumber uint32 `uhppote:"offset:16"` Timestamp types.DateTime `uhppote:"offset:20"` Reason uint8 `uhppote:"offset:27"` Door1State bool `uhppote:"offset:28"` Door2State bool `uhppote:"offset:29"` Door3State bool `uhppote:"offset:30"` Door4State bool `uhppote:"offset:31"` Door1Button bool `uhppote:"offset:32"` Door2Button bool `uhppote:"offset:33"` Door3Button bool `uhppote:"offset:34"` Door4Button bool `uhppote:"offset:35"` SystemError uint8 `uhppote:"offset:36"` SystemDate types.SystemDate `uhppote:"offset:51"` SystemTime types.SystemTime `uhppote:"offset:37"` SequenceId uint32 `uhppote:"offset:40"` SpecialInfo uint8 `uhppote:"offset:48"` RelayState uint8 `uhppote:"offset:49"` // bitmap (0=locked, 1=unlocked, 0000:all doors locked) InputState uint8 `uhppote:"offset:50"` // bitmap (bit 0: force locked, bit 1: fire alarm) }
type EventV6_62 ¶ added in v0.6.8
type GetCardByIDRequest ¶
type GetCardByIDRequest struct { MsgType types.MsgType `uhppote:"value:0x5a"` SerialNumber types.SerialNumber `uhppote:"offset:4"` CardNumber uint32 `uhppote:"offset:8"` }
type GetCardByIDResponse ¶
type GetCardByIDResponse struct { MsgType types.MsgType `uhppote:"value:0x5a"` SerialNumber types.SerialNumber `uhppote:"offset:4"` CardNumber uint32 `uhppote:"offset:8"` From types.Date `uhppote:"offset:12"` To types.Date `uhppote:"offset:16"` Door1 uint8 `uhppote:"offset:20"` Door2 uint8 `uhppote:"offset:21"` Door3 uint8 `uhppote:"offset:22"` Door4 uint8 `uhppote:"offset:23"` PIN types.PIN `uhppote:"offset:24"` }
type GetCardByIndexRequest ¶
type GetCardByIndexRequest struct { MsgType types.MsgType `uhppote:"value:0x5c"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Index uint32 `uhppote:"offset:8"` }
type GetCardByIndexResponse ¶
type GetCardByIndexResponse struct { MsgType types.MsgType `uhppote:"value:0x5c"` SerialNumber types.SerialNumber `uhppote:"offset:4"` CardNumber uint32 `uhppote:"offset:8"` From types.Date `uhppote:"offset:12"` To types.Date `uhppote:"offset:16"` Door1 uint8 `uhppote:"offset:20"` Door2 uint8 `uhppote:"offset:21"` Door3 uint8 `uhppote:"offset:22"` Door4 uint8 `uhppote:"offset:23"` PIN types.PIN `uhppote:"offset:24"` }
type GetCardsRequest ¶
type GetCardsRequest struct { MsgType types.MsgType `uhppote:"value:0x58"` SerialNumber types.SerialNumber `uhppote:"offset:4"` }
type GetCardsResponse ¶
type GetCardsResponse struct { MsgType types.MsgType `uhppote:"value:0x58"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Records uint32 `uhppote:"offset:8"` }
type GetDeviceRequest ¶ added in v0.6.12
type GetDeviceRequest struct { MsgType types.MsgType `uhppote:"value:0x94"` SerialNumber types.SerialNumber `uhppote:"offset:4"` }
type GetDeviceResponse ¶ added in v0.6.12
type GetDeviceResponse struct { MsgType types.MsgType `uhppote:"value:0x94"` SerialNumber types.SerialNumber `uhppote:"offset:4"` IpAddress net.IP `uhppote:"offset:8"` SubnetMask net.IP `uhppote:"offset:12"` Gateway net.IP `uhppote:"offset:16"` MacAddress types.MacAddress `uhppote:"offset:20"` Version types.Version `uhppote:"offset:26"` Date types.Date `uhppote:"offset:28"` }
type GetDoorControlStateRequest ¶
type GetDoorControlStateRequest struct { MsgType types.MsgType `uhppote:"value:0x82"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Door uint8 `uhppote:"offset:8"` }
type GetEventIndexRequest ¶
type GetEventIndexRequest struct { MsgType types.MsgType `uhppote:"value:0xb4"` SerialNumber types.SerialNumber `uhppote:"offset:4"` }
type GetEventIndexResponse ¶
type GetEventIndexResponse struct { MsgType types.MsgType `uhppote:"value:0xb4"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Index uint32 `uhppote:"offset:8"` }
type GetEventRequest ¶
type GetEventRequest struct { MsgType types.MsgType `uhppote:"value:0xb0"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Index uint32 `uhppote:"offset:8"` }
type GetEventResponse ¶
type GetEventResponse struct { MsgType types.MsgType `uhppote:"value:0xb0"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Index uint32 `uhppote:"offset:8"` Type uint8 `uhppote:"offset:12"` Granted bool `uhppote:"offset:13"` Door uint8 `uhppote:"offset:14"` Direction uint8 `uhppote:"offset:15"` CardNumber uint32 `uhppote:"offset:16"` Timestamp types.DateTime `uhppote:"offset:20"` Reason uint8 `uhppote:"offset:27"` }
type GetListenerRequest ¶
type GetListenerRequest struct { MsgType types.MsgType `uhppote:"value:0x92"` SerialNumber types.SerialNumber `uhppote:"offset:4"` }
type GetListenerResponse ¶
type GetStatusRequest ¶
type GetStatusRequest struct { MsgType types.MsgType `uhppote:"value:0x20"` SerialNumber types.SerialNumber `uhppote:"offset:4"` }
type GetStatusResponse ¶
type GetStatusResponse struct { MsgType types.MsgType `uhppote:"value:0x20"` SerialNumber types.SerialNumber `uhppote:"offset:4"` EventIndex uint32 `uhppote:"offset:8"` EventType byte `uhppote:"offset:12"` Granted bool `uhppote:"offset:13"` Door byte `uhppote:"offset:14"` Direction uint8 `uhppote:"offset:15"` CardNumber uint32 `uhppote:"offset:16"` Timestamp types.DateTime `uhppote:"offset:20"` // using zero value for 'no event' Reason uint8 `uhppote:"offset:27"` Door1State bool `uhppote:"offset:28"` Door2State bool `uhppote:"offset:29"` Door3State bool `uhppote:"offset:30"` Door4State bool `uhppote:"offset:31"` Door1Button bool `uhppote:"offset:32"` Door2Button bool `uhppote:"offset:33"` Door3Button bool `uhppote:"offset:34"` Door4Button bool `uhppote:"offset:35"` SystemError uint8 `uhppote:"offset:36"` SystemDate types.SystemDate `uhppote:"offset:51"` SystemTime types.SystemTime `uhppote:"offset:37"` SequenceId uint32 `uhppote:"offset:40"` SpecialInfo uint8 `uhppote:"offset:48"` RelayState uint8 `uhppote:"offset:49"` // bitmap (0=locked, 1=unlocked, 0000:all doors locked) InputState uint8 `uhppote:"offset:50"` // bitmap (bit 0: force locked, bit 1: fire alarm) }
type GetTimeProfileRequest ¶ added in v0.7.0
type GetTimeProfileRequest struct { MsgType types.MsgType `uhppote:"value:0x98"` SerialNumber types.SerialNumber `uhppote:"offset:4"` ProfileID uint8 `uhppote:"offset:8"` }
type GetTimeProfileResponse ¶ added in v0.7.0
type GetTimeProfileResponse struct { MsgType types.MsgType `uhppote:"value:0x98"` SerialNumber types.SerialNumber `uhppote:"offset:4"` ProfileID uint8 `uhppote:"offset:8"` From types.Date `uhppote:"offset:9"` To types.Date `uhppote:"offset:13"` Monday bool `uhppote:"offset:17"` Tuesday bool `uhppote:"offset:18"` Wednesday bool `uhppote:"offset:19"` Thursday bool `uhppote:"offset:20"` Friday bool `uhppote:"offset:21"` Saturday bool `uhppote:"offset:22"` Sunday bool `uhppote:"offset:23"` Segment1Start *types.HHmm `uhppote:"offset:24"` Segment1End *types.HHmm `uhppote:"offset:26"` Segment2Start *types.HHmm `uhppote:"offset:28"` Segment2End *types.HHmm `uhppote:"offset:30"` Segment3Start *types.HHmm `uhppote:"offset:32"` Segment3End *types.HHmm `uhppote:"offset:34"` LinkedProfileID uint8 `uhppote:"offset:36"` }
type GetTimeRequest ¶
type GetTimeRequest struct { MsgType types.MsgType `uhppote:"value:0x32"` SerialNumber types.SerialNumber `uhppote:"offset:4"` }
type GetTimeResponse ¶
type OpenDoorRequest ¶
type OpenDoorRequest struct { MsgType types.MsgType `uhppote:"value:0x40"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Door uint8 `uhppote:"offset:8"` }
type OpenDoorResponse ¶
type OpenDoorResponse struct { MsgType types.MsgType `uhppote:"value:0x40"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type PutCardRequest ¶
type PutCardRequest struct { MsgType types.MsgType `uhppote:"value:0x50"` SerialNumber types.SerialNumber `uhppote:"offset:4"` CardNumber uint32 `uhppote:"offset:8"` From types.Date `uhppote:"offset:12"` To types.Date `uhppote:"offset:16"` Door1 uint8 `uhppote:"offset:20"` Door2 uint8 `uhppote:"offset:21"` Door3 uint8 `uhppote:"offset:22"` Door4 uint8 `uhppote:"offset:23"` PIN types.PIN `uhppote:"offset:24"` }
type PutCardResponse ¶
type PutCardResponse struct { MsgType types.MsgType `uhppote:"value:0x50"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type RecordSpecialEventsRequest ¶ added in v0.6.7
type RecordSpecialEventsRequest struct { MsgType types.MsgType `uhppote:"value:0x8e"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Enable bool `uhppote:"offset:8"` }
Request message layout for 'record special events' (function code 0x8e). Enables or disables events for door open, door closed and door button pressed.
type RecordSpecialEventsResponse ¶ added in v0.6.7
type RecordSpecialEventsResponse struct { MsgType types.MsgType `uhppote:"value:0x8e"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
Response message layout for 'record special events' (function code 0x8e).
type RefreshTaskListRequest ¶ added in v0.7.1
type RefreshTaskListRequest struct { MsgType types.MsgType `uhppote:"value:0xac"` SerialNumber types.SerialNumber `uhppote:"offset:4"` MagicWord uint32 `uhppote:"offset:8"` }
type RefreshTaskListResponse ¶ added in v0.7.1
type RefreshTaskListResponse struct { MsgType types.MsgType `uhppote:"value:0xac"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Refreshed bool `uhppote:"offset:8"` }
type RestoreDefaultParametersRequest ¶ added in v0.8.8
type RestoreDefaultParametersRequest struct { MsgType types.MsgType `uhppote:"value:0xc8"` SerialNumber types.SerialNumber `uhppote:"offset:4"` MagicWord uint32 `uhppote:"offset:8"` }
Request message layout for 'restore default parameters' (function code 0xc8). Resets the controller to the manufacturer default configuration.
type RestoreDefaultParametersResponse ¶ added in v0.8.8
type RestoreDefaultParametersResponse struct { MsgType types.MsgType `uhppote:"value:0xc8"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
Response message layout for 'restore default parameters' (function code 0xc8).
type SetAddressRequest ¶
type SetDoorPasscodesRequest ¶ added in v0.8.7
type SetDoorPasscodesRequest struct { MsgType types.MsgType `uhppote:"value:0x8c"` // message type (0x8c) SerialNumber types.SerialNumber `uhppote:"offset:4"` // controller serial number Door uint8 `uhppote:"offset:8"` // door [1..4] Passcode1 uint32 `uhppote:"offset:12"` // passcode 1 [0..999999] Passcode2 uint32 `uhppote:"offset:16"` // passcode 2 [0..999999] Passcode3 uint32 `uhppote:"offset:20"` // passcode 3 [0..999999] Passcode4 uint32 `uhppote:"offset:24"` // passcode 4 [0..999999] }
Request message to set the supervisor passcodes assigned to a door. Passcoddes are in the range [0..999999], with 0 corresponding to 'no code'
type SetDoorPasscodesResponse ¶ added in v0.8.7
type SetDoorPasscodesResponse struct { MsgType types.MsgType `uhppote:"value:0x8c"` // message type (0x8c) SerialNumber types.SerialNumber `uhppote:"offset:4"` // controller serial number Succeeded bool `uhppote:"offset:8"` // request succeeded/failed }
Response message to a request set the 'super' passwords assigned to a door.
type SetEventIndexRequest ¶
type SetEventIndexResponse ¶
type SetEventIndexResponse struct { MsgType types.MsgType `uhppote:"value:0xb2"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Changed bool `uhppote:"offset:8"` }
type SetFirstCardRequest ¶ added in v0.7.1
type SetFirstCardRequest struct { MsgType types.MsgType `uhppote:"value:0xaa"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Door uint8 `uhppote:"offset:8"` Start types.HHmm `uhppote:"offset:9"` StartDoorControl uint8 `uhppote:"offset:11"` End types.HHmm `uhppote:"offset:12"` EndDoorControl uint8 `uhppote:"offset:14"` Monday bool `uhppote:"offset:15"` Tuesday bool `uhppote:"offset:16"` Wednesday bool `uhppote:"offset:17"` Thursday bool `uhppote:"offset:18"` Friday bool `uhppote:"offset:19"` Saturday bool `uhppote:"offset:20"` Sunday bool `uhppote:"offset:21"` }
type SetFirstCardResponse ¶ added in v0.7.1
type SetFirstCardResponse struct { MsgType types.MsgType `uhppote:"value:0xaa"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type SetInterlockRequest ¶ added in v0.8.5
type SetInterlockRequest struct { MsgType types.MsgType `uhppote:"value:0xa2"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Interlock uint8 `uhppote:"offset:8"` }
type SetInterlockResponse ¶ added in v0.8.5
type SetInterlockResponse struct { MsgType types.MsgType `uhppote:"value:0xa2"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type SetListenerRequest ¶
type SetListenerResponse ¶
type SetListenerResponse struct { MsgType types.MsgType `uhppote:"value:0x90"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type SetPCControlRequest ¶ added in v0.8.4
type SetPCControlResponse ¶ added in v0.8.4
type SetPCControlResponse struct { MsgType types.MsgType `uhppote:"value:0xA0"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type SetTimeProfileRequest ¶ added in v0.7.0
type SetTimeProfileRequest struct { MsgType types.MsgType `uhppote:"value:0x88"` SerialNumber types.SerialNumber `uhppote:"offset:4"` ProfileID uint8 `uhppote:"offset:8"` From types.Date `uhppote:"offset:9"` To types.Date `uhppote:"offset:13"` Monday bool `uhppote:"offset:17"` Tuesday bool `uhppote:"offset:18"` Wednesday bool `uhppote:"offset:19"` Thursday bool `uhppote:"offset:20"` Friday bool `uhppote:"offset:21"` Saturday bool `uhppote:"offset:22"` Sunday bool `uhppote:"offset:23"` Segment1Start types.HHmm `uhppote:"offset:24"` Segment1End types.HHmm `uhppote:"offset:26"` Segment2Start types.HHmm `uhppote:"offset:28"` Segment2End types.HHmm `uhppote:"offset:30"` Segment3Start types.HHmm `uhppote:"offset:32"` Segment3End types.HHmm `uhppote:"offset:34"` LinkedProfileID uint8 `uhppote:"offset:36"` }
type SetTimeProfileResponse ¶ added in v0.7.0
type SetTimeProfileResponse struct { MsgType types.MsgType `uhppote:"value:0x88"` SerialNumber types.SerialNumber `uhppote:"offset:4"` Succeeded bool `uhppote:"offset:8"` }
type SetTimeRequest ¶
type SetTimeResponse ¶
Source Files
¶
- activate_keypads.go
- add_task.go
- clear_task_list.go
- clear_time_profiles.go
- delete_card.go
- delete_cards.go
- events.go
- get_card.go
- get_cards.go
- get_device.go
- get_door_control_state.go
- get_event.go
- get_event_index.go
- get_listener.go
- get_status.go
- get_time.go
- get_time_profile.go
- message.go
- open.go
- put_card.go
- record_special_events.go
- refresh_tasklist.go
- requests.go
- responses.go
- restore_default_parameters.go
- set_address.go
- set_door_control_state.go
- set_door_passcodes.go
- set_event_index.go
- set_first_card.go
- set_interlock.go
- set_listener.go
- set_pc_control.go
- set_time.go
- set_time_profile.go