Electronic locks
An electronic lock is a physical electronic locking device such as an electronic escutcheon or a cylinder. It differs from an access point in that an electronic lock could be a particular model of a device such as a Salto Neo cylinder, an XS4 escutcheon or a Danalock V3 smartlock, for example.
An electronic lock is also a single device whereas an access point could be made up of several devices. An access point could be composed of an electronic lock plus a contact sensor or a controller and a keypad.
This service is responsible for managing electronic lock resources.
Output only. Resource name of the electronic lock. It must have the format of installations/*/electronic-locks/*. For example: installations/surelock-homes-hq/electronic-locks/dancing-men.
Display name of the electronic lock.
The access point that the electronic lock gives coverage to.
Indicates whether this electronic lock has been initialized or not. This field cannot be modified using a standard UpdateElectronicLock operation. To change the value of this field, you must call InitializeElectronicLock. If the value is false also applies to the case where the initialization process has been initiated but where it has not finished.
Device metadata contains information about a device hardware and firmware.
Indicates whether this electronic lock has pending updates or not. This could be because there was a pending configuration or a firmware update and is conditionally set based on the current installation settings.
Indicates whether the battery of this electronic lock is low, and needs replacing, or is normal and doesn't need replacing.
The last time an event was received.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, electronic locks and so on.
Indicates whether this electronic lock is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes. The property is left unset if it is an offline electronic lock.
Calibration settings of an electronic lock. This only applies to electronic locks that must be calibrated once mounted to adapt to the door's specific characteristics. For example, certain motorized electronic locks need to be calibrated so they can learn the different positions of a door.
Indicates whether the electronic lock operates by turning in one direction until it reaches the carriage end, or not. For example, this could apply to electronic locks that are unaware of the carriage's endpoint or those that can lose their position, as seen in double clutch cylinders.
If applicable, the duration the motorized lock's hold-back latch remains engaged before the latch closes.
Parent device name, could be a Gateway or an Extender and takes the form of a relative resource name: installations/surelock-homes-hq/gateways/conan-doyle or installations/surelock-homes-hq/extenders/elementary.
Parent name, when electronic lock is connected to a gateway
Parent name, when electronic lock is connected to an extender
Progress of operation. Range: [0, 100].
Progress of operation. Range: [0, 100].
Circuit boards present in this device.
Date manufactured
Hardware serial number, for example, 2.000.0020
Firmwares present in this circuit board.
Firmware number, for example '0180'.
Firmware version of a specific firmware number.
Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
Month of year. Must be from 1 to 12.
Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
The electronic lock object
Output only. Resource name of the electronic lock. It must have the format of installations/*/electronic-locks/*. For example: installations/surelock-homes-hq/electronic-locks/dancing-men.
Display name of the electronic lock.
The access point that the electronic lock gives coverage to.
Indicates whether this electronic lock has been initialized or not. This field cannot be modified using a standard UpdateElectronicLock operation. To change the value of this field, you must call InitializeElectronicLock. If the value is false also applies to the case where the initialization process has been initiated but where it has not finished.
Device metadata contains information about a device hardware and firmware.
Indicates whether this electronic lock has pending updates or not. This could be because there was a pending configuration or a firmware update and is conditionally set based on the current installation settings.
Indicates whether the battery of this electronic lock is low, and needs replacing, or is normal and doesn't need replacing.
The last time an event was received.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, electronic locks and so on.
Indicates whether this electronic lock is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes. The property is left unset if it is an offline electronic lock.
Calibration settings of an electronic lock. This only applies to electronic locks that must be calibrated once mounted to adapt to the door's specific characteristics. For example, certain motorized electronic locks need to be calibrated so they can learn the different positions of a door.
Indicates whether the electronic lock operates by turning in one direction until it reaches the carriage end, or not. For example, this could apply to electronic locks that are unaware of the carriage's endpoint or those that can lose their position, as seen in double clutch cylinders.
If applicable, the duration the motorized lock's hold-back latch remains engaged before the latch closes.
Parent device name, could be a Gateway or an Extender and takes the form of a relative resource name: installations/surelock-homes-hq/gateways/conan-doyle or installations/surelock-homes-hq/extenders/elementary.
Parent name, when electronic lock is connected to a gateway
Parent name, when electronic lock is connected to an extender
Create an electronic lock
Creates a new electronic lock
Input
Resource name of the parent resource where to create the electronic lock.
The electronic lock resource to be created. Client must not set the ElectronicLock.name field.
The electronic lock ID to use for this electronic lock. In case it's empty the server will autogenerate a unique identifier.
Output
Output only. Resource name of the electronic lock. It must have the format of installations/*/electronic-locks/*.
Display name of the electronic lock.
The access point that the electronic lock gives coverage to.
Indicates whether this electronic lock has been initialized or not. This field cannot be modified using a standard UpdateElectronicLock operation. To change the value of this field, you must call InitializeElectronicLock. If the value is false also applies to the case where the initialization process has been initiated but where it has not finished.
Device metadata contains information about a device hardware and firmware.
Indicates whether this electronic lock has pending updates or not. This could be because there was a pending configuration or a firmware update and is conditionally set based on the current installation settings.
Indicates whether the battery of this electronic lock is low, and needs replacing, or is normal and doesn't need replacing.
The last time an event was received.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, electronic locks and so on.
Indicates whether this electronic lock is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes. The property is left unset if it is an offline electronic lock.
Calibration settings of an electronic lock. This only applies to electronic locks that must be calibrated once mounted to adapt to the door's specific characteristics. For example, certain motorized electronic locks need to be calibrated so they can learn the different positions of a door.
Indicates whether the electronic lock operates by turning in one direction until it reaches the carriage end, or not. For example, this could apply to electronic locks that are unaware of the carriage's endpoint or those that can lose their position, as seen in double clutch cylinders.
If applicable, the duration the motorized lock's hold-back latch remains engaged before the latch closes.
Parent device name, could be a Gateway or an Extender and takes the form of a relative resource name: installations/surelock-homes-hq/gateways/conan-doyle or installations/surelock-homes-hq/extenders/elementary.
Parent name, when electronic lock is connected to a gateway
Parent name, when electronic lock is connected to an extender
Get an electronic lock
Gets an existing electronic lock.
Input
The name of the requested electronic lock resource.
Output
Output only. Resource name of the electronic lock. It must have the format of installations/*/electronic-locks/*.
Display name of the electronic lock.
The access point that the electronic lock gives coverage to.
Indicates whether this electronic lock has been initialized or not. This field cannot be modified using a standard UpdateElectronicLock operation. To change the value of this field, you must call InitializeElectronicLock. If the value is false also applies to the case where the initialization process has been initiated but where it has not finished.
Device metadata contains information about a device hardware and firmware.
Indicates whether this electronic lock has pending updates or not. This could be because there was a pending configuration or a firmware update and is conditionally set based on the current installation settings.
Indicates whether the battery of this electronic lock is low, and needs replacing, or is normal and doesn't need replacing.
The last time an event was received.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, electronic locks and so on.
Indicates whether this electronic lock is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes. The property is left unset if it is an offline electronic lock.
Calibration settings of an electronic lock. This only applies to electronic locks that must be calibrated once mounted to adapt to the door's specific characteristics. For example, certain motorized electronic locks need to be calibrated so they can learn the different positions of a door.
Indicates whether the electronic lock operates by turning in one direction until it reaches the carriage end, or not. For example, this could apply to electronic locks that are unaware of the carriage's endpoint or those that can lose their position, as seen in double clutch cylinders.
If applicable, the duration the motorized lock's hold-back latch remains engaged before the latch closes.
Parent device name, could be a Gateway or an Extender and takes the form of a relative resource name: installations/surelock-homes-hq/gateways/conan-doyle or installations/surelock-homes-hq/extenders/elementary.
Parent name, when electronic lock is connected to a gateway
Parent name, when electronic lock is connected to an extender
List electronic locks
Returns a list of electronic locks that have been previously created.
Input
The parent resource name.
The maximum number of items to return.
The next_page_token value returned from a previous List request, if any.
A filter that chooses which electronic locks to return.
How the results should be sorted.
Output
The field name should match the noun electronic_locks in the method name. There will be a maximum number of items returned based on the page_size field in the request.
Token to retrieve the next page of results, or empty if there are no more results in the list.
Update an electronic lock
Updates an existing electronic lock.
Input
The electronic lock resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Output only. Resource name of the electronic lock. It must have the format of installations/*/electronic-locks/*.
Display name of the electronic lock.
The access point that the electronic lock gives coverage to.
Indicates whether this electronic lock has been initialized or not. This field cannot be modified using a standard UpdateElectronicLock operation. To change the value of this field, you must call InitializeElectronicLock. If the value is false also applies to the case where the initialization process has been initiated but where it has not finished.
Device metadata contains information about a device hardware and firmware.
Indicates whether this electronic lock has pending updates or not. This could be because there was a pending configuration or a firmware update and is conditionally set based on the current installation settings.
Indicates whether the battery of this electronic lock is low, and needs replacing, or is normal and doesn't need replacing.
The last time an event was received.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, electronic locks and so on.
Indicates whether this electronic lock is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes. The property is left unset if it is an offline electronic lock.
Calibration settings of an electronic lock. This only applies to electronic locks that must be calibrated once mounted to adapt to the door's specific characteristics. For example, certain motorized electronic locks need to be calibrated so they can learn the different positions of a door.
Indicates whether the electronic lock operates by turning in one direction until it reaches the carriage end, or not. For example, this could apply to electronic locks that are unaware of the carriage's endpoint or those that can lose their position, as seen in double clutch cylinders.
If applicable, the duration the motorized lock's hold-back latch remains engaged before the latch closes.
Parent device name, could be a Gateway or an Extender and takes the form of a relative resource name: installations/surelock-homes-hq/gateways/conan-doyle or installations/surelock-homes-hq/extenders/elementary.
Parent name, when electronic lock is connected to a gateway
Parent name, when electronic lock is connected to an extender
Delete an electronic lock
Permanently deletes an electronic lock. This cannot be undone.
Input
The resource name of the electronic lock to be deleted.
Output
No return value.
Bind an electronic lock
Binds an electronic lock. Binding an electronic lock assigns a device identifier to the electronic lock. After binding, the device can then be initialized or configured.
Input
The resource name of the electronic lock to be bound.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, electronic locks and so on.
Output
Unbind an electronic lock
Unbinds an electronic lock. Unbinding an electronic lock removes the device identifier from the electronic lock. This may be required in some cases where the electronic lock is not available anymore because, for example, it's broken or damaged. Unbinding allows the initialization of the replacement device without removing it from the installation. It also means the device keeps all the information associated with it, such as events.
Input
The resource name of the electronic lock to be bound.
If set to true, the device identifier is removed (unbound) from the electronic lock. Otherwise, the request will only work if the electronic lock isn't bound to any previous device identifier.
Output
Initialize an electronic lock
Initializes an electronic lock. Electronic locks need to be initialized before you can start to use them.
Input
The resource name of the electronic lock to be initialized.
Output
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set.
The error result of the operation in case of failure or cancellation.
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example: if the original method name is AssignMobileKey(), the inferred response type is AssignMobileKeyResponse.
Configure an electronic lock
Configures an electronic lock. Configuring an electronic lock implies adding some information to the electronic lock such as setting the time zone.
Input
The resource name of the electronic lock to be configured.
Output
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set.
The error result of the operation in case of failure or cancellation.
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example: if the original method name is AssignMobileKey(), the inferred response type is AssignMobileKeyResponse.
Reset an electronic lock
Resetting a device such as an electronic lock means returning it to its factory settings. Resetting is the process of removing the identity as well as all the associated information of an already configured device. Once a device has been reset, you need to reconfigure it.
Input
The resource name of the electronic lock to be reset.
Output
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set.
The error result of the operation in case of failure or cancellation.
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example: if the original method name is AssignMobileKey(), the inferred response type is AssignMobileKeyResponse.
Update electronic lock firmware
Updates an electronic lock's firmware. SALTO provides firmware updates when new functionality is available or when we fix a bug.
Input
The resource name of the electronic lock whose firmware will be updated.
Output
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set.
The error result of the operation in case of failure or cancellation.
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example: if the original method name is AssignMobileKey(), the inferred response type is AssignMobileKeyResponse.
Generate authorization token for an electronic lock
Generates an authorization token that allows to connect to, authenticate and authorize an electronic lock.
Input
The resource name of the electronic lock that the authorization token is generated for.
Output
Authorization token to be used for connecting to an electronic lock.
Generate electronic lock firmware download URI
Provides the download URI for the latest firmware bundle for the electronic lock. The returned URI can be used to bring the electronic lock firmwares up to latest.
Input
The resource name of the electronic lock to get the firmware download URI.
Output
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response is set.
The error result of the operation in case of failure or cancellation.
The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example: if the original method name is AssignMobileKey(), the inferred response type is AssignMobileKeyResponse.
Back
Controllers
Emergency keys