Boks SDK Documentation - v0.0.11
Preparing search index...
Boks SDK Documentation - v0.0.11
Enumerations
BoksClientErrorId
BoksCodeType
BoksOpcode
BoksOpenSource
BoksProtocolErrorId
BoksTransactionStatus
Classes
AnswerDoorStatusPacket
AskDoorStatusPacket
AuthPacket
BleRebootHistoryPacket
BlockResetHistoryPacket
BoksClient
BoksClientError
BoksController
BoksHistoryEvent
BoksPacket
BoksPacketFactory
BoksProtocolError
BoksRXPacket
BoksTransaction
CodeBleInvalidHistoryPacket
CodeBleValidHistoryPacket
CodeKeyInvalidHistoryPacket
CodeKeyValidHistoryPacket
CountCodesPacket
CreateMasterCodePacket
CreateMultiUseCodePacket
CreateSingleUseCodePacket
DeleteMasterCodePacket
DeleteMultiUseCodePacket
DeleteSingleUseCodePacket
DoorCloseHistoryPacket
DoorOpenHistoryPacket
EndHistoryPacket
ErrorBadRequestPacket
ErrorCrcPacket
ErrorHistoryPacket
ErrorNfcScanTimeoutPacket
ErrorNfcTagAlreadyExistsScanPacket
ErrorUnauthorizedPacket
GenerateCodesPacket
GenerateCodesSupportPacket
GetLogsCountPacket
HistoryEraseHistoryPacket
InvalidOpenCodePacket
KeyOpeningHistoryPacket
MasterCodeEditPacket
MultiToSingleCodePacket
NfcOpeningHistoryPacket
NfcRegisteringHistoryPacket
NfcRegisterPacket
NotifyCodeGenerationErrorPacket
NotifyCodeGenerationProgressPacket
NotifyCodeGenerationSuccessPacket
NotifyCodesCountPacket
NotifyDoorStatusPacket
NotifyLogsCountPacket
NotifyMacAddressBoksScalePacket
NotifyNfcTagFoundPacket
NotifyNfcTagRegisteredErrorAlreadyExistsPacket
NotifyNfcTagRegisteredPacket
NotifyNfcTagUnregisteredPacket
NotifyScaleBondingErrorPacket
NotifyScaleBondingForgetSuccessPacket
NotifyScaleBondingProgressPacket
NotifyScaleBondingSuccessPacket
NotifyScaleDisconnectedPacket
NotifyScaleFaultyPacket
NotifyScaleMeasureWeightPacket
NotifyScaleRawSensorsPacket
NotifyScaleTareEmptyOkPacket
NotifyScaleTareLoadedOkPacket
NotifySetConfigurationSuccessPacket
OpenDoorPacket
OperationErrorPacket
OperationSuccessPacket
PowerOffHistoryPacket
PowerOnHistoryPacket
ReactivateCodePacket
RebootPacket
RegeneratePartAPacket
RegeneratePartBPacket
RegisterNfcTagScanStartPacket
RequestLogsPacket
ScaleBondPacket
ScaleForgetPacket
ScaleGetMacPacket
ScaleGetRawSensorsPacket
ScaleMeasureHistoryPacket
ScaleMeasureWeightPacket
ScalePrepareDfuPacket
ScaleReconnectPacket
ScaleTareEmptyPacket
ScaleTareLoadedPacket
SetConfigurationPacket
SingleToMultiCodePacket
TestBatteryPacket
UnregisterNfcTagPacket
ValidOpenCodePacket
WebBluetoothTransport
Interfaces
BoksBatteryStats
BoksClientOptions
BoksHardwareInfo
BoksLogEvents
BoksTransport
NfcScanResult
Type Aliases
BoksLogger
BoksPacketConstructor
Variables
BOKS_SERVICE_UUID
BOKS_UUIDS
CHECKSUM_MASK
DFU_SERVICE_UUID
INVALID_BYTE
MAX_MASTER_CODE_INDEX
PIN_ALGO_CONFIG
Functions
bytesToHex
bytesToMac
bytesToString
calculateChecksum
fetchBatteryLevel
fetchBatteryStats
freeze
generateBoksPin
generateBoksPinFromContext
hexToBytes
parseBatteryLevel
parseBatteryStats
precomputeBoksKeyContext
sealed
stringToBytes
validatePinCode
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Enumerations
Boks
Client
Error
Id
Boks
Code
Type
Boks
Opcode
Boks
Open
Source
Boks
Protocol
Error
Id
Boks
Transaction
Status
Classes
Answer
Door
Status
Packet
Ask
Door
Status
Packet
Auth
Packet
Ble
Reboot
History
Packet
Block
Reset
History
Packet
Boks
Client
Boks
Client
Error
Boks
Controller
Boks
History
Event
Boks
Packet
Boks
Packet
Factory
Boks
Protocol
Error
Boks
RX
Packet
Boks
Transaction
Code
Ble
Invalid
History
Packet
Code
Ble
Valid
History
Packet
Code
Key
Invalid
History
Packet
Code
Key
Valid
History
Packet
Count
Codes
Packet
Create
Master
Code
Packet
Create
Multi
Use
Code
Packet
Create
Single
Use
Code
Packet
Delete
Master
Code
Packet
Delete
Multi
Use
Code
Packet
Delete
Single
Use
Code
Packet
Door
Close
History
Packet
Door
Open
History
Packet
End
History
Packet
Error
Bad
Request
Packet
Error
Crc
Packet
Error
History
Packet
Error
Nfc
Scan
Timeout
Packet
Error
Nfc
Tag
Already
Exists
Scan
Packet
Error
Unauthorized
Packet
Generate
Codes
Packet
Generate
Codes
Support
Packet
Get
Logs
Count
Packet
History
Erase
History
Packet
Invalid
Open
Code
Packet
Key
Opening
History
Packet
Master
Code
Edit
Packet
Multi
To
Single
Code
Packet
Nfc
Opening
History
Packet
Nfc
Registering
History
Packet
Nfc
Register
Packet
Notify
Code
Generation
Error
Packet
Notify
Code
Generation
Progress
Packet
Notify
Code
Generation
Success
Packet
Notify
Codes
Count
Packet
Notify
Door
Status
Packet
Notify
Logs
Count
Packet
Notify
Mac
Address
Boks
Scale
Packet
Notify
Nfc
Tag
Found
Packet
Notify
Nfc
Tag
Registered
Error
Already
Exists
Packet
Notify
Nfc
Tag
Registered
Packet
Notify
Nfc
Tag
Unregistered
Packet
Notify
Scale
Bonding
Error
Packet
Notify
Scale
Bonding
Forget
Success
Packet
Notify
Scale
Bonding
Progress
Packet
Notify
Scale
Bonding
Success
Packet
Notify
Scale
Disconnected
Packet
Notify
Scale
Faulty
Packet
Notify
Scale
Measure
Weight
Packet
Notify
Scale
Raw
Sensors
Packet
Notify
Scale
Tare
Empty
Ok
Packet
Notify
Scale
Tare
Loaded
Ok
Packet
Notify
Set
Configuration
Success
Packet
Open
Door
Packet
Operation
Error
Packet
Operation
Success
Packet
Power
Off
History
Packet
Power
On
History
Packet
Reactivate
Code
Packet
Reboot
Packet
Regenerate
Part
A
Packet
Regenerate
Part
B
Packet
Register
Nfc
Tag
Scan
Start
Packet
Request
Logs
Packet
Scale
Bond
Packet
Scale
Forget
Packet
Scale
Get
Mac
Packet
Scale
Get
Raw
Sensors
Packet
Scale
Measure
History
Packet
Scale
Measure
Weight
Packet
Scale
Prepare
Dfu
Packet
Scale
Reconnect
Packet
Scale
Tare
Empty
Packet
Scale
Tare
Loaded
Packet
Set
Configuration
Packet
Single
To
Multi
Code
Packet
Test
Battery
Packet
Unregister
Nfc
Tag
Packet
Valid
Open
Code
Packet
Web
Bluetooth
Transport
Interfaces
Boks
Battery
Stats
Boks
Client
Options
Boks
Hardware
Info
Boks
Log
Events
Boks
Transport
Nfc
Scan
Result
Type Aliases
Boks
Logger
Boks
Packet
Constructor
Variables
BOKS_
SERVICE_
UUID
BOKS_
UUIDS
CHECKSUM_
MASK
DFU_
SERVICE_
UUID
INVALID_
BYTE
MAX_
MASTER_
CODE_
INDEX
PIN_
ALGO_
CONFIG
Functions
bytes
To
Hex
bytes
To
Mac
bytes
To
String
calculate
Checksum
fetch
Battery
Level
fetch
Battery
Stats
freeze
generate
Boks
Pin
generate
Boks
Pin
From
Context
hex
To
Bytes
parse
Battery
Level
parse
Battery
Stats
precompute
Boks
Key
Context
sealed
string
To
Bytes
validate
Pin
Code
Boks SDK Documentation - v0.0.11
Loading...