Framework

FarpointeSDK

Easily interface with Farpointe Readers

Overview

FarpointeSDK is used to manage the registration, activation, and deactivation of associated Access Cards with relevant Farpointe Reader devices. This library abstracts the complex concepts of NeonFiles, Synchronization, and other Legic-related processes into a simple interface.

Use the shared instance of FarpointeSdk for various actions:

Topics

Essentials

  Quick Setup
Quick setup guide for initial configuration, registering an access card, and access card activation.
  Reader Detection
Allows the user’s device to scan for nearby Readers
class FarpointeSdk
Central point of this library. All configurations, functions, and properties are routed through the shared instance of this class
protocol FarpointeSdkProviding
Providing protocol for FarpointeSdk

Protocols

protocol ReaderDetectorDelegate
Delegate for Reader Detection events

Structures

struct Beacon
iBeacon associated with a nearby Reader during a ReaderDetectorDelegate event
struct FarpointeAccessCard
Access Card used to unlock a nearby Reader
struct FarpointeConfiguration
LEGIC Connect ControlCenter configuration

Enumerations

enum ActivationTime
Timeout options when activating a FarpointeAccessCard
enum DisableReaderConfiguration
Possible configurations when disabling Reader Detection
enum FarpointeError
Errors generated from this SDK or the underlying Legic SDK
enum FarpointeErrorReason
Reasons that the associated FarpointeError occurred