Extenders
An extender is a device such as a repeater or a node which allows the distance between a gateway and an access point to be increased. These devices forward communication signals between electronic locks and gateways. This service is responsible for managing extender resources.
Output only. Resource name of the extender. It must have the format of installations/*/extenders/*. For example: installations/surelock-homes-hq/extenders/elementary.
Display name of the extender.
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 extender is connected to a gateway
Parent name, when extender is connected to an extender
Progress of operation. Range: [0, 100].
The extender object
Output only. Resource name of the extender. It must have the format of installations/*/extenders/*. For example: installations/surelock-homes-hq/extenders/elementary.
Display name of the extender.
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 extender is connected to a gateway
Parent name, when extender is connected to an extender
Create an extender
Creates a new extender
Input
Resource name of the parent resource where to create the extender.
The extender resource to be created. Client must not set the Extender.name field.
The extender ID to use for this extender. In case it's empty the server will autogenerate a unique identifier.
Output
Output only. Resource name of the extender. It must have the format of installations/*/extenders/*.
Display name of the extender.
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 extender is connected to a gateway
Parent name, when extender is connected to an extender
Get an extender
Gets an existing extender.
Input
The name of the requested extender resource.
Output
Output only. Resource name of the extender. It must have the format of installations/*/extenders/*.
Display name of the extender.
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 extender is connected to a gateway
Parent name, when extender is connected to an extender
List extenders
Returns a list of extenders 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 extenders to return.
How the results should be sorted.
Output
The field name should match the noun extenders 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 extender
Updates an existing extender.
Input
The extender resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Output only. Resource name of the extender. It must have the format of installations/*/extenders/*.
Display name of the extender.
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 extender is connected to a gateway
Parent name, when extender is connected to an extender
Delete an extender
Permanently deletes an extender. This cannot be undone.
Input
The resource name of the extender to be deleted.
Output
No return value.
Bind an extender
Binds an extender. Binding an extender assigns a device identifier to the extender.
Input
The resource name of the extender 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 extender
Unbinds an extender. Unbinding an extender removes the device identifier from the extender.
Input
The resource name of the gateway to be unbound.
Output
Update extender firmware
Updates an extender's firmware. SALTO provides firmware updates when new functionality is available or when we fix a bug.
Input
The resource name of the extender 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.
Reset an extender
Resetting a device such as an extender 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.
Input
The resource name of the extender 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.
Generate extender firmware download URI
Provides the download URI for the latest firmware bundle for the extender. The returned URI can be used to bring the extender firmwares up to latest.
Input
The resource name of the extender 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
