uhppote

Sep 5, 2024

Changes in this version

+ var ErrIncorrectController = errors.New("response from incorrect controller")

+ var ErrInvalidCard = errors.New("invalid card")

+ var ErrInvalidListenerAddress = errors.New("invalid listener address")

+ var NOTIMEOUT = time.Time

type Device

+ Protocol string

+ func (d Device) IsValid() bool

type IUHPPOTE

+ ListenAddrList func() []netip.AddrPort

Mar 26, 2024

Changes in this version

type IUHPPOTE

+ RestoreDefaultParameters func(controllerID uint32) (bool, error)

Nov 30, 2023

Changes in this version

type IUHPPOTE

+ SetDoorPasscodes func(controllerID uint32, door uint8, passcodes ...uint32) (bool, error)

Aug 28, 2023

Changes in this version

type IUHPPOTE

+ ActivateKeypads func(controllerID uint32, readers map[uint8]bool) (bool, error)

Jun 13, 2023

Changes in this version

type IUHPPOTE

+ SetInterlock func(controllerID uint32, interlock types.Interlock) (bool, error)

Mar 14, 2023

Changes in this version

type IUHPPOTE

+ SetPCControl func(deviceID uint32, enable bool) (bool, error)

Jul 1, 2021

Changes in this version

type IUHPPOTE

+ AddTask func(deviceID uint32, task types.Task) (bool, error)

+ ClearTaskList func(deviceID uint32) (bool, error)

+ RefreshTaskList func(deviceID uint32) (bool, error)

Jun 11, 2021

Changes in this version

+ var NONE = time.Time

type Device

+ func (d Device) Clone() Device

+ type IUHPPOTE interface

+ ClearTimeProfiles func(deviceID uint32) (bool, error)

+ DeleteCard func(deviceID uint32, cardNumber uint32) (bool, error)

+ DeleteCards func(deviceID uint32) (bool, error)

+ DeviceList func() map[uint32]Device

+ GetCardByID func(deviceID, cardNumber uint32) (*types.Card, error)

+ GetCardByIndex func(deviceID, index uint32) (*types.Card, error)

+ GetCards func(deviceID uint32) (uint32, error)

+ GetDevice func(deviceID uint32) (*types.Device, error)

+ GetDevices func() ([]types.Device, error)

+ GetDoorControlState func(deviceID uint32, door byte) (*types.DoorControlState, error)

+ GetEvent func(deviceID, index uint32) (*types.Event, error)

+ GetEventIndex func(deviceID uint32) (*types.EventIndex, error)

+ GetListener func(deviceID uint32) (*types.Listener, error)

+ GetStatus func(deviceID uint32) (*types.Status, error)

+ GetTime func(deviceID uint32) (*types.Time, error)

+ GetTimeProfile func(deviceID uint32, profileID uint8) (*types.TimeProfile, error)

+ Listen func(listener Listener, q chan os.Signal) error

+ ListenAddr func() *net.UDPAddr

+ OpenDoor func(deviceID uint32, door uint8) (*types.Result, error)

+ PutCard func(deviceID uint32, card types.Card) (bool, error)

+ RecordSpecialEvents func(deviceID uint32, enable bool) (bool, error)

+ SetAddress func(deviceID uint32, address, mask, gateway net.IP) (*types.Result, error)

+ SetDoorControlState func(deviceID uint32, door uint8, state uint8, delay uint8) (*types.DoorControlState, error)

+ SetEventIndex func(deviceID, index uint32) (*types.EventIndexResult, error)

+ SetListener func(deviceID uint32, address net.UDPAddr) (*types.Result, error)

+ SetTime func(deviceID uint32, datetime time.Time) (*types.Time, error)

+ SetTimeProfile func(deviceID uint32, profile types.TimeProfile) (bool, error)

+ func NewUHPPOTE(bind, broadcast, listen net.UDPAddr, timeout time.Duration, devices []Device, ...) IUHPPOTE

Apr 28, 2021

Changes in this version

type Device

+ Name string

+ TimeZone *time.Location

type UHPPOTE

+ func (u *UHPPOTE) BroadcastAddr() *net.UDPAddr

+ func (u *UHPPOTE) BroadcastTo(serialNumber uint32, request, reply interface{}) ([]interface{}, error)

+ func (u *UHPPOTE) GetDevice(serialNumber uint32) (*types.Device, error)

+ func (u *UHPPOTE) GetDevices() ([]types.Device, error)

Jan 2, 2021

Changes in this version

type Device

+ func (d *Device) ID() uint32

+ func (d *Device) RolloverAt() uint32

type UHPPOTE

+ func (u *UHPPOTE) DeviceList() map[uint32]*Device

+ func (u *UHPPOTE) RecordSpecialEvents(deviceID uint32, enable bool) (bool, error)

Aug 14, 2020

Changes in this version

+ var VERSION string = "v0.6.4"

+ func GetCardByIndex(u iuhppote, deviceID, index uint32) (*types.Card, error)

+ type Device struct

+ Address *net.UDPAddr

+ DeviceID uint32

+ Doors []string

+ Rollover uint32

+ func NewDevice(deviceID uint32, address *net.UDPAddr, rollover uint32, doors []string) *Device

+ type Event struct

+ CardNumber uint32

+ Direction uint8

+ Door byte

+ Door1Button bool

+ Door1State bool

+ Door2Button bool

+ Door2State bool

+ Door3Button bool

+ Door3State bool

+ Door4Button bool

+ Door4State bool

+ EventIndex uint32

+ EventType byte

+ Granted bool

+ InputState uint8

+ MsgType types.MsgType

+ Reason byte

+ RelayState uint8

+ SequenceId uint32

+ SerialNumber types.SerialNumber

+ SpecialInfo uint8

+ SystemDate types.SystemDate

+ SystemError uint8

+ SystemTime types.SystemTime

+ Timestamp types.DateTime

+ type GetListenerResponse struct

+ Address net.IP

+ MsgType types.MsgType

+ Port uint16

+ SerialNumber types.SerialNumber

+ type Listener interface

+ OnConnected func()

+ OnError func(error) bool

+ OnEvent func(*types.Status)

+ type UHPPOTE struct

+ BindAddress *net.UDPAddr

+ BroadcastAddress *net.UDPAddr

+ Debug bool

+ Devices map[uint32]*Device

+ ListenAddress *net.UDPAddr

+ func (u *UHPPOTE) Broadcast(request, replies interface{}) error

+ func (u *UHPPOTE) DeleteCard(serialNumber, cardNumber uint32) (*types.Result, error)

+ func (u *UHPPOTE) DeleteCardN(deviceID uint32, card types.Card) (bool, error)

+ func (u *UHPPOTE) DeleteCards(serialNumber uint32) (*types.Result, error)

+ func (u *UHPPOTE) DirectedBroadcast(serialNumber uint32, request, replies interface{}) error

+ func (u *UHPPOTE) Execute(serialNumber uint32, request, reply interface{}) error

+ func (u *UHPPOTE) FindDevice(serialNumber uint32) (*types.Device, error)

+ func (u *UHPPOTE) FindDevices() ([]types.Device, error)

+ func (u *UHPPOTE) GetCardByID(serialNumber, cardNumber uint32) (*types.Card, error)

+ func (u *UHPPOTE) GetCardByIdN(deviceID, cardNumber uint32) (*types.Card, error)

+ func (u *UHPPOTE) GetCardByIndex(deviceID, index uint32) (*types.Card, error)

+ func (u *UHPPOTE) GetCards(serialNumber uint32) (*types.RecordCount, error)

+ func (u *UHPPOTE) GetCardsN(deviceID uint32) (uint32, error)

+ func (u *UHPPOTE) GetDoorControlState(serialNumber uint32, door byte) (*types.DoorControlState, error)

+ func (u *UHPPOTE) GetEvent(serialNumber, index uint32) (*types.Event, error)

+ func (u *UHPPOTE) GetEventIndex(serialNumber uint32) (*types.EventIndex, error)

+ func (u *UHPPOTE) GetListener(serialNumber uint32) (*types.Listener, error)

+ func (u *UHPPOTE) GetStatus(serialNumber uint32) (*types.Status, error)

+ func (u *UHPPOTE) GetTime(serialNumber uint32) (*types.Time, error)

+ func (u *UHPPOTE) Listen(listener Listener, q chan os.Signal) error

+ func (u *UHPPOTE) OpenDoor(serialNumber uint32, door uint8) (*types.Result, error)

+ func (u *UHPPOTE) PutCard(serialNumber uint32, card types.Card) (*types.Result, error)

+ func (u *UHPPOTE) PutCardN(deviceID uint32, card types.Card) (bool, error)

+ func (u *UHPPOTE) Send(serialNumber uint32, request interface{}) (messages.Response, error)

+ func (u *UHPPOTE) SetAddress(serialNumber uint32, address, mask, gateway net.IP) (*types.Result, error)

+ func (u *UHPPOTE) SetDoorControlState(serialNumber uint32, door uint8, state uint8, delay uint8) (*types.DoorControlState, error)

+ func (u *UHPPOTE) SetEventIndex(serialNumber, index uint32) (*types.EventIndexResult, error)

+ func (u *UHPPOTE) SetListener(serialNumber uint32, address net.UDPAddr) (*types.Result, error)

+ func (u *UHPPOTE) SetTime(serialNumber uint32, datetime time.Time) (*types.Time, error)