@dodi-smart/nuki-graphql-api
Version:
Nuki GraphQL API
104 lines • 4.36 kB
TypeScript
export type Smartlock_Config = {
/**
* The name of the smartlock for new users
*/
name: string;
/**
* The latitude of the smartlock position
*/
latitude: number;
/**
* The longitude of the smartlock position
*/
longitude: number;
/**
* The capabilities indicate whether door opening via app is possible, RTO is possible or both: 0 .. only door opening possible, 1 .. both possible, 2 .. only RTO possible (only for type=2)
*/
readonly capabilities?: number;
/**
* True if the door should be unlatched on unlocking (knob) (only for type=1 and type=3)
*/
autoUnlatch?: boolean;
/**
* True if the door has a lift up handle, which is required to be lifted up to lock the door
*/
liftUpHandle?: boolean;
/**
* True if the pairing is allowed via the smartlock button
*/
pairingEnabled?: boolean;
/**
* True if the button on the smartlock is enabled
*/
buttonEnabled?: boolean;
/**
* True if the LED on the smartlock is enabled
*/
ledEnabled?: boolean;
/**
* The brightness of the LED: 0 .. off, 5 .. max (only for type=1 and type=3)
*/
ledBrightness?: number;
/**
* [deprecated] The timezone offset (in minutes)
*/
timezoneOffset: number;
/**
* [deprecated] The daylight saving mode: 0 .. off, 1 .. european
*/
daylightSavingMode?: number;
/**
* True if a fob is paired with the smartlock
*/
readonly fobPaired?: boolean;
/**
* The fob action if button is pressed once: type=0/3/4: 0 .. none, 1 .. unlock, 2 .. lock, 3 .. lock 'n' go, 4 .. intelligent (lock/unlocked based on the current state); type=2: 0 .. none, 1 .. toggle ring to open, 2 .. activate ring to open, 3 .. deactivate ring to open, 7 .. open (electric strike actuation), 8 .. ring
*/
readonly fobAction1?: number;
/**
* The fob action if button is pressed twice: type=0/3/4: 0 .. none, 1 .. unlock, 2 .. lock, 3 .. lock 'n' go, 4 .. intelligent (lock/unlocked based on the current state); type=2: 0 .. none, 1 .. toggle ring to open, 2 .. activate ring to open, 3 .. deactivate ring to open, 7 .. open (electric strike actuation), 8 .. ring
*/
readonly fobAction2?: number;
/**
* The fob action if button is pressed 3 times: type=0/3/4: 0 .. none, 1 .. unlock, 2 .. lock, 3 .. lock 'n' go, 4 .. intelligent (lock/unlocked based on the current state); type=2: 0 .. none, 1 .. toggle ring to open, 2 .. activate ring to open, 3 .. deactivate ring to open, 7 .. open (electric strike actuation), 8 .. ring
*/
readonly fobAction3?: number;
/**
* True if the smartlock should only lock once (instead of twice) (only for type=1)
*/
singleLock: boolean;
/**
* The operating mode of the opener (only for type=2): 0x00 .. generic door opener, 0x01 .. analogue intercom, 0x02 .. digital intercom, 0x03 .. digital intercom Siedle, 0x04 .. digital intercom TCS, 0x05 .. digital intercom Bticino, 0x06 .. analog intercom Siedle HTS, 0x07 .. digital intercom STR, 0x08 .. digital intercom Ritto, 0x09 .. digital intercom Fermax, 0x0A .. digital intercom Comelit, 0x0B .. digital intercom Urmet BiBus, 0x0C .. digital intercom Urmet 2Voice, 0x0D .. digital intercom Golmar, 0x0E .. digital intercom SKS, 0x0F .. digital intercom Spare
*/
readonly operatingMode?: number;
/**
* The advertising mode (battery saving): 0 .. automatic, 1 .. normal, 2 .. slow, 3 .. slowest
*/
advertisingMode: number;
/**
* True if a keypad is paired with the smartlock
*/
readonly keypadPaired?: boolean;
keypad2Paired?: boolean;
/**
* The homekit state: 0 .. unavailable, 1 .. disabled, 2 .. enabled, 3 .. enabled & paired
*/
readonly homekitState?: number;
/**
* The timezone id (check https://developer.nuki.io for ids)
*/
timezoneId: number;
/**
* The device type of a Nuki device
*/
readonly deviceType?: number;
/**
* Flag that indicates if the devices internal WIFI module can be used
*/
readonly wifiEnabled?: boolean;
/**
* The operation id - if set it's locked for another operation
*/
readonly operationId?: string;
};
//# sourceMappingURL=Smartlock_Config.d.ts.map