pn532

package module

Go to main page

Versions in this module

v0

v0.22.1

Apr 26, 2026

v0.22.0

Apr 14, 2026

v0.21.1

Apr 11, 2026

Changes in this version

+ var ErrTagDataMismatch = errors.New("tag data format mismatch")

+ var ErrTagIncompatible = errors.New("tag is incompatible with NDEF formatting")

+ var ErrTagInvalidState = errors.New("tag in invalid state")

+ var ErrTagTimeout = errors.New("tag timeout")

v0.21.0

Apr 2, 2026

Changes in this version

type NTAGTag

+ func (t *NTAGTag) MakeReadOnly(ctx context.Context) error

v0.20.3

Feb 7, 2026

Changes in this version

+ func IsDeviceGoneError(err error) bool

+ type DeviceHealthChecker interface

+ CheckHealth func() error

type MockTransport

+ func (m *MockTransport) CheckHealth() error

+ func (m *MockTransport) SetHealthError(err error)

v0.20.2

Jan 20, 2026

v0.20.1

Jan 17, 2026

v0.20.0

Jan 17, 2026

Changes in this version

type NTAGTag

+ func (t *NTAGTag) GetCachedUserDataPage() []byte

v0.19.0

Jan 17, 2026

Changes in this version

type NTAGTag

+ func (t *NTAGTag) GetCachedCapabilityContainer() []byte

v0.18.0

Jan 17, 2026

v0.17.0

Jan 17, 2026

Changes in this version

+ const ConnectionBackoffMultiplier

+ const ConnectionInitialBackoff

+ const ConnectionJitter

+ const ConnectionMaxBackoff

+ const ConnectionRetryTimeout

+ const DefaultConnectionRetries

+ const DefaultPassiveActivationRetries

+ const DefaultPollingRetries

+ const NDEFMaxRetries

+ const NDEFRetryDelay1

+ const NDEFRetryDelay2

+ const NDEFRetryDelay3

+ const NTAGBlockReadRetries

+ const NTAGFallbackRetries

+ const NTAGTimeoutRetryDelay

+ const TransportACKDelay1

+ const TransportACKDelay2

+ const TransportACKDelay3

+ const TransportACKRetries

+ const TransportACKTimeout

+ const TransportDrainRetries

+ const TransportI2CFrameRetries

+ const TransportWakeupRetries

+ const UARTWakeupDelay1

+ const UARTWakeupDelay2

+ const UARTWakeupDelay3

+ func CloseSessionLog() error

+ func GetSessionLogPath() string

+ func InitSessionLog() (string, error)

+ func IsPN532RFError(err error) bool

type Device

+ func (d *Device) CycleRFField(ctx context.Context) error

+ func (d *Device) HardReset(ctx context.Context) error

+ func (d *Device) InDeselect(ctx context.Context) error

type MIFARETag

+ func (t *MIFARETag) AuthenticateWithRetry(ctx context.Context, sector uint8, keyType byte, key []byte) error

+ func (t *MIFARETag) IsAuthenticated() bool

+ func (t *MIFARETag) ReadNDEFWithRetry(ctx context.Context) (*NDEFMessage, error)

+ func (t *MIFARETag) TryAuthenticate(ctx context.Context) error

type MockTransport

+ func (*MockTransport) HasCapability(capability TransportCapability) bool

+ func (m *MockTransport) Reconnect() error

+ func (m *MockTransport) SetReconnectError(err error)

type NTAGTag

+ func (t *NTAGTag) HasNDEF() bool

+ func (t *NTAGTag) ReadNDEFWithRetry(ctx context.Context) (*NDEFMessage, error)

type PN532Error

+ func (e *PN532Error) IsRFError() bool

+ type Reconnecter interface

+ Reconnect func() error

v0.16.0

Jan 14, 2026

v0.15.1

Jan 5, 2026

Changes in this version

type Device

+ func (d *Device) SendDataExchangeWithRetry(ctx context.Context, data []byte) ([]byte, error)

v0.15.0

Jan 3, 2026

Changes in this version

+ func IsFatal(err error) bool

v0.14.0

Jan 1, 2026

Changes in this version

+ const TLVTypeLockControl

+ const TLVTypeMemoryControl

+ const TLVTypeNDEF

+ const TLVTypeNull

+ const TLVTypeTerminator

+ var ErrTLVDataTooShort = errors.New("TLV data too short")

+ var ErrTLVInvalidLength = errors.New("TLV invalid length format")

+ var ErrTLVNDEFNotFound = errors.New("NDEF TLV not found")

+ var ErrTLVTerminatorFirst = errors.New("terminator TLV before NDEF")

+ func ExtractNDEFFromTLV(data []byte) ([]byte, error)

+ func TLVDebugInfo(data []byte) string

type Manufacturer

+ const ManufacturerFudan

+ type NDEFLocation struct

+ HeaderSize int

+ Length int

+ Offset int

+ func ScanForNDEFTLV(data []byte) (*NDEFLocation, error)

v0.13.1

Dec 26, 2025

v0.13.0

Dec 26, 2025

Changes in this version

+ func GetClaimedSizeFromCC(ccData []byte) int

+ func IsGenuineNXP(uid []byte) bool

type BaseTag

+ func (t *BaseTag) IsGenuine() bool

+ func (t *BaseTag) Manufacturer() Manufacturer

type DetectedTag

+ func (t *DetectedTag) IsGenuine() bool

+ func (t *DetectedTag) Manufacturer() Manufacturer

+ type Manufacturer string

+ const ManufacturerInfineon

+ const ManufacturerNXP

+ const ManufacturerST

+ const ManufacturerTI

+ const ManufacturerUnknown

+ func GetManufacturer(uid []byte) Manufacturer

type NTAGTag

+ func (t *NTAGTag) ProbeActualMemorySize(ctx context.Context, claimedBytes int) (lastPage uint8, userMemory int)

+ func (t *NTAGTag) ReadCapabilityContainer(ctx context.Context) ([]byte, error)

v0.12.0

Dec 20, 2025

v0.11.1

Dec 16, 2025

v0.11.0

Dec 14, 2025

v0.10.2

Dec 8, 2025

v0.10.1

Dec 8, 2025

v0.10.0

Dec 8, 2025

Changes in this version

+ var ErrWriteVerificationFailed = errors.New("write verification failed: data mismatch")

+ func Debugf(format string, args ...any)

+ func Debugln(args ...any)

type MockTransport

+ func (m *MockTransport) QueueResponse(cmd byte, response []byte)

+ func (m *MockTransport) QueueResponses(cmd byte, responses ...[]byte)

v0.9.1

Dec 8, 2025

Changes in this version

+ func WriteNDEFWithRetry(ctx context.Context, writeFunc WriteNDEFFunc, maxRetries int, tagType string) error

type PN532Error

+ BytesSent int

+ Target byte

+ func NewPN532ErrorWithDetails(errorCode byte, command string, bytesSent int, target byte) *PN532Error

+ type WriteNDEFFunc func(ctx context.Context) error

v0.9.0

Dec 6, 2025

Changes in this version

+ func HasTrace(err error) bool

type Device

+ func (d *Device) InListPassiveTarget(ctx context.Context, maxTg, brTy byte) ([]*DetectedTag, error)

+ func (d *Device) InListPassiveTargetWithTimeout(ctx context.Context, maxTg, brTy, mxRtyATR byte) ([]*DetectedTag, error)

+ func (d *Device) Reset(ctx context.Context) error

+ func (d *Device) SelectTag(ctx context.Context, tag *DetectedTag) error

type MockTransport

+ func (m *MockTransport) DeselectTarget()

+ func (m *MockTransport) DisableRFField()

+ func (m *MockTransport) EnableRFField()

+ func (m *MockTransport) GetState() (powerMode PN532PowerMode, rfFieldOn, targetSelected bool)

+ func (m *MockTransport) SelectTarget()

+ func (m *MockTransport) SetPowerMode(mode PN532PowerMode)

+ type PN532PowerMode int

+ const PN532PowerModeNormal

+ const PN532PowerModePowerDown

+ const PN532PowerModeSleep

+ type TraceBuffer struct

+ func NewTraceBuffer(transport, port string, maxSize int) *TraceBuffer

+ func (tb *TraceBuffer) Clear()

+ func (tb *TraceBuffer) RecordRX(data []byte, note string)

+ func (tb *TraceBuffer) RecordTX(data []byte, note string)

+ func (tb *TraceBuffer) RecordTimeout(note string)

+ func (tb *TraceBuffer) WrapError(err error) error

+ type TraceDirection string

+ const TraceRX

+ const TraceTX

+ type TraceEntry struct

+ Data []byte

+ Direction TraceDirection

+ Note string

+ Timestamp time.Time

+ func (e TraceEntry) String() string

+ type TraceableError struct

+ Err error

+ Port string

+ Trace []TraceEntry

+ Transport string

+ func GetTrace(err error) *TraceableError

+ func (e *TraceableError) Error() string

+ func (e *TraceableError) FormatTrace() string

+ func (e *TraceableError) Unwrap() error

v0.8.3

Nov 18, 2025

v0.8.2

Oct 24, 2025

v0.8.1

Sep 17, 2025

Changes in this version

type Device

+ func (d *Device) ClearTransportState() error

type DeviceConfig

+ MaxFastReadPages int

type TransportCapability

+ const CapabilityUART

v0.8.0

Sep 17, 2025

Changes in this version

+ var ErrCommandNotSupported = errors.New("command not supported by device")

+ var ErrTagDataCorrupt = errors.New("tag data appears corrupted")

+ var ErrTagEmptyData = errors.New("tag detected but returned empty data")

+ var ErrTagUnreliable = errors.New("tag readings are inconsistent")

+ func IsCommandNotSupported(err error) bool

+ func IsPN532AuthenticationError(err error) bool

+ func IsPN532TimeoutError(err error) bool

+ func IsRecoverable(err error) bool

+ type CommandRetryProfile int

+ const ProfileDataExchange

+ const ProfileDefault

+ const ProfileDetection

+ const ProfileStatus

+ func GetCommandRetryProfile(cmd byte) CommandRetryProfile

type Device

+ func (d *Device) SetPassiveActivationRetries(maxRetries byte) error

+ func (d *Device) SetPollingRetries(mxRtyATR byte) error

+ type IsRetryableFunc func(error) bool

type MIFARETag

+ func (t *MIFARETag) ReadNDEFRobust() (*NDEFMessage, error)

type NTAGTag

+ func (t *NTAGTag) ReadNDEFRobust() (*NDEFMessage, error)

+ type PN532Error struct

+ Command string

+ Context string

+ ErrorCode byte

+ func NewPN532Error(errorCode byte, command, context string) *PN532Error

+ func (e *PN532Error) Error() string

+ func (e *PN532Error) IsAuthenticationError() bool

+ func (e *PN532Error) IsCommandNotSupported() bool

+ func (e *PN532Error) IsTimeoutError() bool

+ type ReadNDEFFunc func() (*NDEFMessage, error)

type RetryConfig

+ func GetRetryConfigForCommand(cmd byte) *RetryConfig

+ func GetRetryConfigForProfile(profile CommandRetryProfile) *RetryConfig

v0.7.0

Sep 9, 2025

Changes in this version

type MIFARETag

+ func (t *MIFARETag) FormatForNDEF() error

+ func (t *MIFARETag) IsNDEFFormatted() bool

+ func (t *MIFARETag) WriteBlockAutoAlternative(block uint8, data []byte) error

+ func (t *MIFARETag) WriteNDEFAlternative(message *NDEFMessage) error

v0.6.1

Aug 20, 2025

v0.6.0

Aug 20, 2025

v0.5.0

Aug 19, 2025

Changes in this version

type BaseTag

+ func (*BaseTag) WriteNDEFWithContext(_ context.Context, _ *NDEFMessage) error

type ConnectOption

+ func WithConnectionRetries(maxAttempts int) ConnectOption

+ func WithDeviceDetector(detector func(*detection.Options) ([]detection.DeviceInfo, error)) ConnectOption

type FeliCaTag

+ func (f *FeliCaTag) WriteNDEFWithContext(_ context.Context, message *NDEFMessage) error

type MIFARETag

+ func (t *MIFARETag) AuthenticateContext(ctx context.Context, sector uint8, keyType byte, key []byte) error

+ func (t *MIFARETag) AuthenticateRobustContext(ctx context.Context, sector uint8, keyType byte, key []byte) error

+ func (t *MIFARETag) WriteNDEFWithContext(ctx context.Context, _ *NDEFMessage) error

type MockTransport

+ func (m *MockTransport) SendCommandWithContext(ctx context.Context, cmd byte, _ []byte) ([]byte, error)

type NTAGTag

+ func (t *NTAGTag) WriteNDEFWithContext(ctx context.Context, message *NDEFMessage) error

type Tag

+ WriteNDEFWithContext func(ctx context.Context, message *NDEFMessage) error

type Transport

+ SendCommandWithContext func(ctx context.Context, cmd byte, args []byte) ([]byte, error)

type TransportWithRetry

+ func (t *TransportWithRetry) SendCommandWithContext(ctx context.Context, cmd byte, args []byte) ([]byte, error)

v0.4.0

Aug 16, 2025

Changes in this version

type Device

+ func (d *Device) InListPassiveTargetWithTimeoutContext(ctx context.Context, maxTg, brTy, mxRtyATR byte) ([]*DetectedTag, error)

+ func (d *Device) SimplePoll(ctx context.Context, interval time.Duration) (*DetectedTag, error)

+ type MIFAREConfig struct

+ HardwareDelay time.Duration

+ RetryConfig *RetryConfig

+ func DefaultMIFAREConfig() *MIFAREConfig

type MIFARETag

+ func (t *MIFARETag) SetConfig(config *MIFAREConfig)

+ func (t *MIFARETag) SetRetryConfig(config *RetryConfig)

+ type MockTransport struct

+ func NewMockTransport() *MockTransport

+ func (*MockTransport) Type() TransportType

+ func (m *MockTransport) ClearError(cmd byte)

+ func (m *MockTransport) Close() error

+ func (m *MockTransport) GetCallCount(cmd byte) int

+ func (m *MockTransport) IsConnected() bool

+ func (m *MockTransport) Reset()

+ func (m *MockTransport) SendCommand(cmd byte, _ []byte) ([]byte, error)

+ func (m *MockTransport) SetDelay(delay time.Duration)

+ func (m *MockTransport) SetError(cmd byte, err error)

+ func (m *MockTransport) SetResponse(cmd byte, response []byte)

+ func (m *MockTransport) SetTimeout(timeout time.Duration) error

v0.3.1

Aug 15, 2025

Changes in this version

+ type SimpleMockTransport struct

+ Error error

+ Response []byte

+ func NewSimpleMockTransport() *SimpleMockTransport

+ func (*SimpleMockTransport) Close() error

+ func (*SimpleMockTransport) IsConnected() bool

+ func (*SimpleMockTransport) SetTimeout(_ time.Duration) error

+ func (*SimpleMockTransport) Type() TransportType

+ func (m *SimpleMockTransport) SendCommand(_ byte, _ []byte) ([]byte, error)

+ func (m *SimpleMockTransport) SetError(err error)

+ func (m *SimpleMockTransport) SetResponse(response []byte)

type ValidatedMIFARETag

+ func (t *ValidatedMIFARETag) ReadBlockValidatedWithContext(ctx context.Context, block uint8) ([]byte, error)

+ func (t *ValidatedMIFARETag) WriteBlockValidatedWithContext(ctx context.Context, block uint8, data []byte) error

type ValidatedNTAGTag

+ func (t *ValidatedNTAGTag) ReadBlockValidatedWithContext(ctx context.Context, block uint8) ([]byte, error)

+ func (t *ValidatedNTAGTag) WriteBlockValidatedWithContext(ctx context.Context, block uint8, data []byte) error

v0.3.0

Aug 14, 2025

Changes in this version

type TagType

+ const TagTypeAny

v0.2.0

Aug 12, 2025

v0.1.0

Aug 12, 2025

Changes in this version

+ const AuthTypeOpen

+ const AuthTypeWPA

+ const AuthTypeWPA2

+ const AuthTypeWPA2PSK

+ const AuthTypeWPAPSK

+ const DiagnoseAttentionTest

+ const DiagnoseCommunicationTest

+ const DiagnoseEchoBackTest

+ const DiagnosePollingTest

+ const DiagnoseRAMTest

+ const DiagnoseROMTest

+ const DiagnoseSelfAntennaTest

+ const EncryptTypeAES

+ const EncryptTypeNone

+ const EncryptTypeTKIP

+ const EncryptTypeWEP

+ const MIFAREKeyA

+ const MIFAREKeyB

+ const TNFAbsoluteURI

+ const TNFEmpty

+ const TNFExternalType

+ const TNFMediaType

+ const TNFReserved

+ const TNFUnchanged

+ const TNFUnknown

+ const TNFWellKnown

+ const WakeupGPIOP32

+ const WakeupGPIOP34

+ const WakeupHSU

+ const WakeupI2C

+ const WakeupINT1

+ const WakeupRF

+ const WakeupSPI

+ var ErrChecksumMismatch = errors.New("checksum mismatch")

+ var ErrCommandFailed = errors.New("command execution failed")

+ var ErrCommunicationFailed = errors.New("communication failed")

+ var ErrDataTooLarge = errors.New("data too large")

+ var ErrDeviceNotFound = errors.New("device not found")

+ var ErrDeviceNotSupported = errors.New("device not supported")

+ var ErrFrameCorrupted = errors.New("frame corrupted")

+ var ErrIncompleteRecord = errors.New("incomplete NDEF record")

+ var ErrInvalidChunking = errors.New("invalid chunking")

+ var ErrInvalidFormat = errors.New("invalid data format")

+ var ErrInvalidIDLength = errors.New("invalid ID length")

+ var ErrInvalidMBME = errors.New("invalid MB/ME flags")

+ var ErrInvalidNDEF = errors.New("invalid NDEF format")

+ var ErrInvalidParameter = errors.New("invalid parameter")

+ var ErrInvalidPayloadLength = errors.New("invalid PAYLOAD length")

+ var ErrInvalidRecordHeader = errors.New("invalid NDEF record header")

+ var ErrInvalidResponse = errors.New("invalid response format")

+ var ErrInvalidTLV = errors.New("invalid TLV structure")

+ var ErrInvalidTNF = errors.New("invalid TNF value")

+ var ErrInvalidTag = errors.New("invalid tag type")

+ var ErrInvalidTypeLength = errors.New("invalid TYPE length")

+ var ErrNACKReceived = errors.New("NACK received")

+ var ErrNoACK = errors.New("no ACK received")

+ var ErrNoNDEF = errors.New("no NDEF record found")

+ var ErrNoTagDetected = errors.New("no tag detected")

+ var ErrNotImplemented = errors.New("not implemented")

+ var ErrSecurityViolation = errors.New("security violation: data exceeds safety limits")

+ var ErrTagAuthFailed = errors.New("tag authentication failed")

+ var ErrTagNotFound = errors.New("tag not found")

+ var ErrTagReadFailed = errors.New("tag read failed")

+ var ErrTagUnsupported = errors.New("tag type not supported")

+ var ErrTagWriteFailed = errors.New("tag write failed")

+ var ErrTimeout = errors.New("operation timeout")

+ var ErrTooManyRecords = errors.New("too many NDEF records")

+ var ErrTransportClosed = errors.New("transport is closed")

+ var ErrTransportNotReady = errors.New("transport not ready")

+ var ErrTransportRead = errors.New("transport read failed")

+ var ErrTransportTimeout = errors.New("transport timeout")

+ var ErrTransportWrite = errors.New("transport write failed")

+ var MaxNDEFIDLength = 255

+ var MaxNDEFMessageSize = 8192

+ var MaxNDEFPayloadSize = 4096

+ var MaxNDEFRecordCount = 255

+ var MaxNDEFTypeLength = 255

+ func BuildNDEFMessage(text string) ([]byte, error)

+ func BuildNDEFMessageEx(records []NDEFRecord) ([]byte, error)

+ func BuildTextMessage(text string) ([]byte, error)

+ func BuildURIMessage(uri string) ([]byte, error)

+ func BuildVCardMessage(name, phone, email string) ([]byte, error)

+ func BuildVCardRecord(contact *VCardContact) (*ndef.Record, error)

+ func BuildWiFiMessage(ssid, password string, authType, encType uint16) ([]byte, error)

+ func BuildWiFiRecord(cred WiFiCredential) (*ndef.Record, error)

+ func ExponentialBackoff(attempt int, initial time.Duration, maxDuration time.Duration, ...) time.Duration

+ func IsDebugEnabled() bool

+ func IsRetryable(err error) bool

+ func IsValidNDEFMessage(data []byte) bool

+ func IsValidNDEFPayload(payload []byte) bool

+ func Retry(ctx context.Context, fn RetryableFunc) error

+ func RetryWithConfig(ctx context.Context, config *RetryConfig, retryFunc RetryableFunc) error

+ func SetDebugEnabled(enabled bool)

+ func ValidateNDEFMessage(data []byte) error

+ func ValidateNDEFPayload(payload []byte) error

+ type AccessControlConfig struct

+ AuthFailureLimit uint8

+ ConfigLock bool

+ Protection bool

+ type Address struct

+ City string

+ Country string

+ PostalCode string

+ State string

+ Street string

+ type AutoPollResult struct

+ TargetData []byte

+ Type AutoPollTarget

+ func (a *AutoPollResult) ToDetectedTag() *DetectedTag

+ type AutoPollTarget byte

+ const AutoPollFeliCa212

+ const AutoPollFeliCa424

+ const AutoPollGeneric106kbps

+ const AutoPollGeneric212kbps

+ const AutoPollGeneric424kbps

+ const AutoPollISO14443A

+ const AutoPollISO14443B

+ const AutoPollISO14443B4

+ const AutoPollJewel

+ const AutoPollMifare

+ type BaseTag struct

+ func (*BaseTag) ReadBlock(_ uint8) ([]byte, error)

+ func (*BaseTag) ReadNDEF() (*NDEFMessage, error)

+ func (*BaseTag) WriteBlock(_ uint8, _ []byte) error

+ func (*BaseTag) WriteNDEF(_ *NDEFMessage) error

+ func (t *BaseTag) DebugInfo() string

+ func (t *BaseTag) DebugInfoWithNDEF(ndefReader interface{ ... }) string

+ func (t *BaseTag) IsMIFARE4K() bool

+ func (t *BaseTag) ReadText() (string, error)

+ func (t *BaseTag) Summary() string

+ func (t *BaseTag) Type() TagType

+ func (t *BaseTag) UID() string

+ func (t *BaseTag) UIDBytes() []byte

+ func (t *BaseTag) WriteText(text string) error

+ type ConnectOption func(*connectConfig) error

+ func WithAutoDetection() ConnectOption

+ func WithConnectTimeout(timeout time.Duration) ConnectOption

+ func WithDeviceOptions(opts ...Option) ConnectOption

+ func WithTransportFactory(factory TransportFactory) ConnectOption

+ func WithTransportFromDeviceFactory(factory TransportFromDeviceFactory) ConnectOption

+ func WithValidation(config *ValidationConfig) ConnectOption

+ type ContinuousPollConfig struct

+ CompatibilityMode bool

+ MaxRetries int

+ PollCount byte

+ PollPeriod byte

+ RetryDelay time.Duration

+ RetryOnFailure bool

+ Strategy PollStrategy

+ TargetTypes []AutoPollTarget

+ func DefaultContinuousPollConfig() *ContinuousPollConfig

+ func (c *ContinuousPollConfig) Clone() *ContinuousPollConfig

+ func (c *ContinuousPollConfig) Validate() error

+ type DetectedTag struct

+ ATQ []byte

+ DetectedAt time.Time

+ FromInAutoPoll bool

+ SAK byte

+ TargetData []byte

+ TargetNumber byte

+ Type TagType

+ UID string

+ UIDBytes []byte

+ type Device struct

+ func ConnectDevice(path string, opts ...ConnectOption) (*Device, error)

+ func New(transport Transport, opts ...Option) (*Device, error)

+ func NewWithOptions(transport Transport, opts ...Option) (*Device, error)

+ func (d *Device) Close() error

+ func (d *Device) CreateTag(detected *DetectedTag) (Tag, error)

+ func (d *Device) DetectTag() (*DetectedTag, error)

+ func (d *Device) DetectTagContext(ctx context.Context) (*DetectedTag, error)

+ func (d *Device) DetectTags(maxTags, baudRate byte) ([]*DetectedTag, error)

+ func (d *Device) DetectTagsContext(ctx context.Context, maxTags, baudRate byte) ([]*DetectedTag, error)

+ func (d *Device) Diagnose(testNumber byte, data []byte) (*DiagnoseResult, error)

+ func (d *Device) DiagnoseContext(ctx context.Context, testNumber byte, data []byte) (*DiagnoseResult, error)

+ func (d *Device) GetCurrentPollStrategy() PollStrategy

+ func (d *Device) GetFirmwareVersion() (*FirmwareVersion, error)

+ func (d *Device) GetFirmwareVersionContext(ctx context.Context) (*FirmwareVersion, error)

+ func (d *Device) GetGeneralStatus() (*GeneralStatus, error)

+ func (d *Device) GetGeneralStatusContext(ctx context.Context) (*GeneralStatus, error)

+ func (d *Device) GetPollConfig() *ContinuousPollConfig

+ func (d *Device) InAutoPoll(pollCount, pollPeriod byte, targetTypes []AutoPollTarget) ([]AutoPollResult, error)

+ func (d *Device) InAutoPollContext(ctx context.Context, pollCount, pollPeriod byte, targetTypes []AutoPollTarget) ([]AutoPollResult, error)

+ func (d *Device) InListPassiveTargetContext(ctx context.Context, maxTg, brTy byte) ([]*DetectedTag, error)

+ func (d *Device) InRelease(targetNumber byte) error

+ func (d *Device) InReleaseContext(ctx context.Context, targetNumber byte) error

+ func (d *Device) InSelect(targetNumber byte) error

+ func (d *Device) InSelectContext(ctx context.Context, targetNumber byte) error

+ func (d *Device) Init() error

+ func (d *Device) InitContext(ctx context.Context) error

+ func (d *Device) InitiatorListPassiveTargets(maxTags int, tagType TagType, uid []byte) ([]*DetectedTag, error)

+ func (d *Device) IsAutoPollSupported() bool

+ func (d *Device) PollForTag(ctx context.Context, pollInterval time.Duration) (*DetectedTag, error)

+ func (d *Device) PowerDown(wakeupEnable, irqEnable byte) error

+ func (d *Device) PowerDownContext(ctx context.Context, wakeupEnable, irqEnable byte) error

+ func (d *Device) SAMConfiguration(mode SAMMode, timeout, irq byte) error

+ func (d *Device) SAMConfigurationContext(ctx context.Context, mode SAMMode, timeout, irq byte) error

+ func (d *Device) SendDataExchange(data []byte) ([]byte, error)

+ func (d *Device) SendDataExchangeContext(ctx context.Context, data []byte) ([]byte, error)

+ func (d *Device) SendRawCommand(data []byte) ([]byte, error)

+ func (d *Device) SendRawCommandContext(ctx context.Context, data []byte) ([]byte, error)

+ func (d *Device) SetPollConfig(config *ContinuousPollConfig) error

+ func (d *Device) SetRetryConfig(config *RetryConfig)

+ func (d *Device) SetTimeout(timeout time.Duration) error

+ func (d *Device) Transport() Transport

+ func (d *Device) WaitForTag(ctx context.Context) (*DetectedTag, error)

+ type DeviceConfig struct

+ RetryConfig *RetryConfig

+ Timeout time.Duration

+ func DefaultDeviceConfig() *DeviceConfig

+ type DiagnoseResult struct

+ Data []byte

+ Success bool

+ TestNumber byte

+ type ErrorType int

+ const ErrorTypePermanent

+ const ErrorTypeTimeout

+ const ErrorTypeTransient

+ func GetErrorType(err error) ErrorType

+ type FeliCaTag struct

+ func NewFeliCaTag(device *Device, targetData []byte) (*FeliCaTag, error)

+ func (f *FeliCaTag) DebugInfo() string

+ func (f *FeliCaTag) GetIDm() []byte

+ func (f *FeliCaTag) GetPMm() []byte

+ func (f *FeliCaTag) GetServiceCode() uint16

+ func (f *FeliCaTag) GetSystemCode() uint16

+ func (f *FeliCaTag) Polling(systemCode uint16) error

+ func (f *FeliCaTag) ReadBlock(block uint8) ([]byte, error)

+ func (f *FeliCaTag) ReadBlockExtended(block uint16) ([]byte, error)

+ func (f *FeliCaTag) ReadNDEF() (*NDEFMessage, error)

+ func (f *FeliCaTag) RequestService(serviceCodes []uint16) ([]byte, error)

+ func (f *FeliCaTag) SetServiceCode(serviceCode uint16)

+ func (f *FeliCaTag) SetSystemCode(systemCode uint16)

+ func (f *FeliCaTag) WriteBlock(block uint8, data []byte) error

+ func (f *FeliCaTag) WriteBlockExtended(block uint16, data []byte) error

+ func (f *FeliCaTag) WriteNDEF(message *NDEFMessage) error

+ func (f *FeliCaTag) WriteText(text string) error

+ type FirmwareVersion struct

+ SupportIso14443a bool

+ SupportIso14443b bool

+ SupportIso18092 bool

+ Version string

+ type GeneralStatus struct

+ FieldPresent bool

+ LastError byte

+ Targets byte

+ type MIFARETag struct

+ func NewMIFARETag(device *Device, uid []byte, sak byte) *MIFARETag

+ func (*MIFARETag) AnalyzeLastError(err error) string

+ func (t *MIFARETag) Authenticate(sector uint8, keyType byte, key []byte) error

+ func (t *MIFARETag) AuthenticateRobust(sector uint8, keyType byte, key []byte) error

+ func (t *MIFARETag) DebugInfo() string

+ func (t *MIFARETag) GetDevice() *Device

+ func (t *MIFARETag) GetTimingVariance() time.Duration

+ func (t *MIFARETag) IsTimingUnstable() bool

+ func (t *MIFARETag) ReadBlock(block uint8) ([]byte, error)

+ func (t *MIFARETag) ReadBlockAuto(block uint8) ([]byte, error)

+ func (t *MIFARETag) ReadBlockDirect(block uint8) ([]byte, error)

+ func (t *MIFARETag) ReadNDEF() (*NDEFMessage, error)

+ func (t *MIFARETag) ResetAuthState() error

+ func (t *MIFARETag) WriteBlock(block uint8, data []byte) error

+ func (t *MIFARETag) WriteBlockAuto(block uint8, data []byte) error

+ func (t *MIFARETag) WriteBlockDirect(block uint8, data []byte) error

+ func (t *MIFARETag) WriteNDEF(message *NDEFMessage) error

+ func (t *MIFARETag) WriteText(text string) error

+ type NDEFMessage struct

+ Records []NDEFRecord

+ func ParseNDEFData(data []byte) (*NDEFMessage, error)

+ func ParseNDEFMessage(data []byte) (*NDEFMessage, error)

+ type NDEFRecord struct

+ Payload []byte

+ Text string

+ Type NDEFRecordType

+ URI string

+ VCard *VCardContact

+ WiFi *WiFiCredential

+ type NDEFRecordType string

+ const NDEFTypeBluetooth

+ const NDEFTypeSmartPoster

+ const NDEFTypeText

+ const NDEFTypeURI

+ const NDEFTypeVCard

+ const NDEFTypeWiFi

+ type NTAGTag struct

+ func NewNTAGTag(device *Device, uid []byte, sak byte) *NTAGTag

+ func (t *NTAGTag) DebugInfo() string

+ func (t *NTAGTag) DetectType() error

+ func (t *NTAGTag) DisablePasswordProtection() error

+ func (t *NTAGTag) FastRead(startAddr, endAddr uint8) ([]byte, error)

+ func (t *NTAGTag) GetConfigPage() uint8

+ func (t *NTAGTag) GetPasswordPage() uint8

+ func (t *NTAGTag) GetTotalPages() uint8

+ func (t *NTAGTag) GetUserMemoryRange() (start, end uint8)

+ func (t *NTAGTag) GetVersion() (*NTAGVersion, error)

+ func (t *NTAGTag) LockPage(page uint8) error

+ func (t *NTAGTag) PwdAuth(password []byte) ([]byte, error)

+ func (t *NTAGTag) ReadBlock(block uint8) ([]byte, error)

+ func (t *NTAGTag) ReadNDEF() (*NDEFMessage, error)

+ func (t *NTAGTag) SetAccessControl(config AccessControlConfig) error

+ func (t *NTAGTag) SetPasswordProtection(password, pack []byte, auth0 uint8) error

+ func (t *NTAGTag) WriteBlock(block uint8, data []byte) error

+ func (t *NTAGTag) WriteNDEF(message *NDEFMessage) error

+ func (t *NTAGTag) WriteText(text string) error

+ type NTAGType uint8

+ const NTAGType213

+ const NTAGType215

+ const NTAGType216

+ const NTAGTypeUnknown

+ type NTAGVersion struct

+ FixedHeader uint8

+ MajorVersion uint8

+ MinorVersion uint8

+ ProductSubtype uint8

+ ProductType uint8

+ ProtocolType uint8

+ StorageSize uint8

+ VendorID uint8

+ func (v *NTAGVersion) GetNTAGType() NTAGType

+ func (v *NTAGVersion) GetStorageSize() int

+ type OptimizedPollParams struct

+ MaxRetries int

+ PollPeriod byte

+ RetryDelay time.Duration

+ StabilizationDelay time.Duration

+ TargetTypes []AutoPollTarget

+ type Option func(*Device) error

+ func WithMaxRetries(maxAttempts int) Option

+ func WithRetryBackoff(initialBackoff time.Duration) Option

+ func WithRetryConfig(config *RetryConfig) Option

+ func WithTimeout(timeout time.Duration) Option

+ type PollStrategy string

+ const PollStrategyAuto

+ const PollStrategyAutoPoll

+ const PollStrategyLegacy

+ const PollStrategyManual

+ type RetryConfig struct

+ BackoffMultiplier float64

+ InitialBackoff time.Duration

+ Jitter float64

+ MaxAttempts int

+ MaxBackoff time.Duration

+ RetryTimeout time.Duration

+ func DefaultRetryConfig() *RetryConfig

+ type RetryableFunc func() error

+ type SAMMode byte

+ const SAMModeDualCard

+ const SAMModeNormal

+ const SAMModeVirtualCard

+ const SAMModeWiredCard

+ const SAMNormal

+ type Tag interface

+ DebugInfo func() string

+ ReadBlock func(block uint8) ([]byte, error)

+ ReadNDEF func() (*NDEFMessage, error)

+ ReadText func() (string, error)

+ Summary func() string

+ Type func() TagType

+ UID func() string

+ UIDBytes func() []byte

+ WriteBlock func(block uint8, data []byte) error

+ WriteNDEF func(message *NDEFMessage) error

+ WriteText func(text string) error

+ type TagContext interface

+ ReadBlockContext func(ctx context.Context, block uint8) ([]byte, error)

+ ReadNDEFContext func(ctx context.Context) (*NDEFMessage, error)

+ WriteBlockContext func(ctx context.Context, block uint8, data []byte) error

+ WriteNDEFContext func(ctx context.Context, message *NDEFMessage) error

+ func AsTagContext(tag Tag, device *Device) TagContext

+ type TagType string

+ const CardTypeAny

+ const TagTypeFeliCa

+ const TagTypeMIFARE

+ const TagTypeNTAG

+ const TagTypeUnknown

+ type Transport interface

+ Close func() error

+ IsConnected func() bool

+ SendCommand func(cmd byte, args []byte) ([]byte, error)

+ SetTimeout func(timeout time.Duration) error

+ Type func() TransportType

+ type TransportCapability string

+ const CapabilityAutoPollNative

+ const CapabilityRequiresInSelect

+ type TransportCapabilityChecker interface

+ HasCapability func(capability TransportCapability) bool

+ type TransportContext interface

+ SendCommandContext func(ctx context.Context, cmd byte, args []byte) ([]byte, error)

+ func AsTransportContext(t Transport) TransportContext

+ type TransportError struct

+ Err error

+ Op string

+ Port string

+ Retryable bool

+ Type ErrorType

+ func NewChecksumMismatchError(op, port string) *TransportError

+ func NewDataTooLargeError(op, port string) *TransportError

+ func NewFrameCorruptedError(op, port string) *TransportError

+ func NewInvalidResponseError(op, port string) *TransportError

+ func NewNACKReceivedError(op, port string) *TransportError

+ func NewNoACKError(op, port string) *TransportError

+ func NewTimeoutError(op, port string) *TransportError

+ func NewTransportError(op, port string, err error, errType ErrorType) *TransportError

+ func NewTransportNotReadyError(op, port string) *TransportError

+ func NewTransportReadError(op, port string) *TransportError

+ func NewTransportWriteError(op, port string) *TransportError

+ func (e *TransportError) Error() string

+ func (e *TransportError) Unwrap() error

+ type TransportFactory func(path string) (Transport, error)

+ type TransportFromDeviceFactory func(device detection.DeviceInfo) (Transport, error)

+ type TransportOptimizer interface

+ GetPreferredStrategy func() PollStrategy

+ GetStabilizationDelay func() time.Duration

+ OptimizeForPolling func(strategy PollStrategy) *OptimizedPollParams

+ type TransportType string

+ const TransportI2C

+ const TransportMock

+ const TransportSPI

+ const TransportUART

+ type TransportWithRetry struct

+ func NewTransportWithRetry(transport Transport, config *RetryConfig) *TransportWithRetry

+ func (t *TransportWithRetry) Close() error

+ func (t *TransportWithRetry) HasCapability(capability TransportCapability) bool

+ func (t *TransportWithRetry) IsConnected() bool

+ func (t *TransportWithRetry) SendCommand(cmd byte, args []byte) ([]byte, error)

+ func (t *TransportWithRetry) SetRetryConfig(config *RetryConfig)

+ func (t *TransportWithRetry) SetTimeout(timeout time.Duration) error

+ func (t *TransportWithRetry) Type() TransportType

+ type VCardContact struct

+ Addresses map[string]Address

+ EmailAddresses map[string]string

+ FirstName string

+ FormattedName string

+ LastName string

+ Note string

+ Organization string

+ PhoneNumbers map[string]string

+ Title string

+ URL string

+ Version string

+ func ParseVCardRecord(rec *ndef.Record) (*VCardContact, error)

+ type ValidatedDevice struct

+ func NewValidatedDevice(transport Transport, config *ValidationConfig) (*ValidatedDevice, error)

+ func (vd *ValidatedDevice) GetValidationMetrics() ValidationMetrics

+ func (vd *ValidatedDevice) ValidateInputSize(data []byte, operation string) error

+ type ValidatedMIFARETag struct

+ func NewValidatedMIFARETag(tag *MIFARETag, config *ValidationConfig) *ValidatedMIFARETag

+ func (t *ValidatedMIFARETag) ReadBlockValidated(block uint8) ([]byte, error)

+ func (t *ValidatedMIFARETag) ReadNDEFValidated() (*NDEFMessage, error)

+ func (t *ValidatedMIFARETag) ReadTextValidated() (string, error)

+ func (t *ValidatedMIFARETag) WriteBlockValidated(block uint8, data []byte) error

+ func (t *ValidatedMIFARETag) WriteNDEFValidated(message *NDEFMessage) error

+ func (t *ValidatedMIFARETag) WriteTextValidated(text string) error

+ type ValidatedNTAGTag struct

+ func NewValidatedNTAGTag(tag *NTAGTag, config *ValidationConfig) *ValidatedNTAGTag

+ func (t *ValidatedNTAGTag) ReadBlockValidated(block uint8) ([]byte, error)

+ func (t *ValidatedNTAGTag) ReadNDEFValidated() (*NDEFMessage, error)

+ func (t *ValidatedNTAGTag) ReadTextValidated() (string, error)

+ func (t *ValidatedNTAGTag) WriteBlockValidated(block uint8, data []byte) error

+ func (t *ValidatedNTAGTag) WriteNDEFValidated(message *NDEFMessage) error

+ func (t *ValidatedNTAGTag) WriteTextValidated(text string) error

+ type ValidatedTag interface

+ ReadBlockValidated func(block uint8) ([]byte, error)

+ ReadNDEFValidated func() (*NDEFMessage, error)

+ WriteBlockValidated func(block uint8, data []byte) error

+ WriteNDEFValidated func(message *NDEFMessage) error

+ type ValidationConfig struct

+ EnableReadVerification bool

+ EnableWriteVerification bool

+ ReadRetries int

+ RetryDelay time.Duration

+ WriteRetries int

+ func DefaultValidationConfig() *ValidationConfig

+ type ValidationMetrics struct

+ FailedValidations uint64

+ LastValidation time.Time

+ SecurityViolations uint64

+ TotalOperations uint64

+ type ValidationResult struct

+ SecurityViolation bool

+ Success bool

+ type WiFiCredential struct

+ AuthType uint16

+ EncryptionType uint16

+ Hidden bool

+ MACAddress string

+ NetworkKey string

+ SSID string

+ func ParseWiFiRecord(rec *ndef.Record) (*WiFiCredential, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL