Encoders
An encoder is a device that reads and updates keys with access information. This service is responsible for managing encoder resources.
Output only. Resource name of the encoder. It must have the format of installations/*/encoders/*. For example: installations/surelock-homes-hq/encoders/dancing-men.
Display name of the encoder.
Indicates whether this encoder has been initialized or not. This field cannot be modified using a standard UpdateEncoder operation. To change the value of this field, you must call InitializeEncoder. 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 encoder is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes.
The last time an event was received.
Indicates whether this encoder 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.
Disables the sound emitted by the encoder during operation.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
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 encoder is connected to a gateway
Parent name, when encoder is connected to an extender
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 encoder object
Output only. Resource name of the encoder. It must have the format of installations/*/encoders/*. For example: installations/surelock-homes-hq/encoders/dancing-men.
Display name of the encoder.
Indicates whether this encoder has been initialized or not. This field cannot be modified using a standard UpdateEncoder operation. To change the value of this field, you must call InitializeEncoder. 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 encoder is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes.
The last time an event was received.
Indicates whether this encoder 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.
Disables the sound emitted by the encoder during operation.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
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 encoder is connected to a gateway
Parent name, when encoder is connected to an extender
Create an encoder
Creates a new encoder.
Input
Resource name of the parent resource where to create the encoder.
The encoder resource to be created. Client must not set the Encoder.name field.
The encoder ID to use for this encoder. In case it's empty the server will autogenerate a unique identifier.
Output
Output only. Resource name of the encoder. It must have the format of installations/*/encoders/*.
Display name of the encoder.
Indicates whether this encoder has been initialized or not. This field cannot be modified using a standard UpdateEncoder operation. To change the value of this field, you must call InitializeEncoder. 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 encoder is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes.
The last time an event was received.
Indicates whether this encoder 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.
Disables the sound emitted by the encoder during operation.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
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 encoder is connected to a gateway
Parent name, when encoder is connected to an extender
Get an encoder
Gets an existing encoder.
Input
The name of the requested encoder resource.
Output
Output only. Resource name of the encoder. It must have the format of installations/*/encoders/*.
Display name of the encoder.
Indicates whether this encoder has been initialized or not. This field cannot be modified using a standard UpdateEncoder operation. To change the value of this field, you must call InitializeEncoder. 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 encoder is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes.
The last time an event was received.
Indicates whether this encoder 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.
Disables the sound emitted by the encoder during operation.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
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 encoder is connected to a gateway
Parent name, when encoder is connected to an extender
List encoders
Returns a list of encoders 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 encoders to return.
How the results should be sorted.
Output
The field name should match the noun encoders 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 encoder
Updates an existing encoder.
Input
The encoder resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Output only. Resource name of the encoder. It must have the format of installations/*/encoders/*.
Display name of the encoder.
Indicates whether this encoder has been initialized or not. This field cannot be modified using a standard UpdateEncoder operation. To change the value of this field, you must call InitializeEncoder. 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 encoder is connected or not. It's considered connected if there has been at least one communication with it within the last 10 minutes.
The last time an event was received.
Indicates whether this encoder 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.
Disables the sound emitted by the encoder during operation.
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
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 encoder is connected to a gateway
Parent name, when encoder is connected to an extender
Delete an encoder
Permanently deletes an encoder. This cannot be undone.
Input
The resource name of the encoder to be deleted.
Output
No return value.
Initialize an encoder
Initializes an encoder. Encoders need to be initialized before you can start to use them.
Input
The resource name of the encoder 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 encoder
Configures an encoder. Configuring an encoder implies adding some information to the encoder based on the current settings.
Input
The resource name of the encoder 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 encoder
Resetting a device such as an encoder 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 encoder 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 encoder firmware
Updates an encoder's firmware. SALTO provides firmware updates when new functionality is available or when we fix a bug.
Input
The resource name of the encoder 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.
Bind an encoder
Binds an encoder. Binding an encoder assigns a device identifier to the encoder. After binding, the device can then be initialized or configured.
Input
The resource name of the encoder 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 encoder
Unbinds an encoder. Unbinding an encoder removes the device identifier from the encoder. This may be required in some cases where the encoder 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 encoder to be unbound.
If set to true, the device identifier is removed (unbound) from the encoder. Otherwise, the request will only work if the encoder isn't bound to any previous device identifier.
Output
Read a key
Reads a key presented on an encoder.
Input
The name of the requested encoder resource.
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.
Generates an authorization token for an encoder
Generates an authorization token that allows to connect, authenticate and authorize against an encoder.
Input
The resource name of the encoder that the authorization token is generated for.
Output
Authorization token to be used for connecting against an encoder.
Generate encoder firmware download URI
Provides the download URI for the latest firmware bundle for the encoder. The returned URI can be used to bring the encoder firmwares up to latest.
Input
The resource name of the encoder 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
Emergency keys
Events