Controllers
Controllers are mains-wired hardware devices that can be used to control access where a standalone lock cannot be fitted. For example, on car park barriers, turnstiles or sliding doors. They allow the management of multiple accesses from a single device.
For example, a single controller could control access to both the entrance and exit of a building via a turnstile.
This service is responsible for managing controller resources.
Output only. Resource name of the controller. It must have the format of installations/*/controllers/*. For example: installations/surelock-homes-hq/controller/dancing-men.
Display name of the controller.
The access points that the controller gives coverage to.
Indicates whether this controller has been initialized or not. This field cannot be modified using a standard UpdateController operation. To change the value of this field, you must call InitializeController. 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 controller 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.
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 controller 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 controller.
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 controller is connected to a gateway
Parent name, when controller is connected to an extender
Output only. Resource name of the controller relay. It must have the format of installations/*/controllers/*/relays/*. For example: installations/surelock-homes-hq/controller/dancing-men/relays/first-floor.
Identifies the specific controller relay on the board (1-4). Board type determines which controller relay IDs are actually available for configuration and use.
Extension board address. Values range from 0-15, allowing for up to 16 boards in the system. This field is not applicable for master boards or wall reader extension boards.
Defines the controller relay type, allowing for different controller relay configurations.
Destination output configuration for this controller relay.
Strike configuration for this controller relay.
Progress of operation. Range: [0, 100].
Progress of operation. Range: [0, 100].
Progress of operation. Range: [0, 100].
Circuit boards present in this device.
Resource name of the destination the controller relay points to. For example: installations/surelock-homes-hq/destinations/elevator-floor-5.
Resource name of the access point the controller relay points to. For example: installations/surelock-homes-hq/access-points/baker-street-entrance.
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.
Relay represents a configurable output from a controller that can be used to control
external devices such as doors or other electrical systems. Relays can be located on the main controller board or on extension boards, with addressing determined by dipswitch settings.
Output only. Resource name of the controller relay. It must have the format of installations/*/controllers/*/relays/*. For example: installations/surelock-homes-hq/controller/dancing-men/relays/first-floor.
Identifies the specific controller relay on the board (1-4). Board type determines which controller relay IDs are actually available for configuration and use.
Extension board address. Values range from 0-15, allowing for up to 16 boards in the system. This field is not applicable for master boards or wall reader extension boards.
Defines the controller relay type, allowing for different controller relay configurations.
Destination output configuration for this controller relay.
Strike configuration for this controller relay.
The controller object
Output only. Resource name of the controller. It must have the format of installations/*/controllers/*. For example: installations/surelock-homes-hq/controller/dancing-men.
Display name of the controller.
The access points that the controller gives coverage to.
Indicates whether this controller has been initialized or not. This field cannot be modified using a standard UpdateController operation. To change the value of this field, you must call InitializeController. 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 controller 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.
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 controller 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 controller.
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 controller is connected to a gateway
Parent name, when controller is connected to an extender
Create a controller
Creates a new controller
Input
Resource name of the parent resource where to create the controller.
The controller resource to be created. Client must not set the Controller.name field.
The controller ID to use for this controller. In case it's empty the server will autogenerate a unique identifier.
Output
Output only. Resource name of the controller. It must have the format of installations/*/controllers/*.
Display name of the controller.
The access points that the controller gives coverage to.
Indicates whether this controller has been initialized or not. This field cannot be modified using a standard UpdateController operation. To change the value of this field, you must call InitializeController. 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 controller 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.
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 controller 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 controller.
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 controller is connected to a gateway
Parent name, when controller is connected to an extender
Get a controller
Gets an existing controller.
Input
The name of the requested controller resource.
Output
Output only. Resource name of the controller. It must have the format of installations/*/controllers/*.
Display name of the controller.
The access points that the controller gives coverage to.
Indicates whether this controller has been initialized or not. This field cannot be modified using a standard UpdateController operation. To change the value of this field, you must call InitializeController. 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 controller 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.
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 controller 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 controller.
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 controller is connected to a gateway
Parent name, when controller is connected to an extender
List controllers
Returns a list of controllers 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 controllers to return.
How the results should be sorted.
Output
The field name should match the noun controllers 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 a controller
Updates an existing controller.
Input
The controller resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Output only. Resource name of the controller. It must have the format of installations/*/controllers/*.
Display name of the controller.
The access points that the controller gives coverage to.
Indicates whether this controller has been initialized or not. This field cannot be modified using a standard UpdateController operation. To change the value of this field, you must call InitializeController. 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 controller 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.
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 controller 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 controller.
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 controller is connected to a gateway
Parent name, when controller is connected to an extender
Delete a controller
Permanently deletes a controller. This cannot be undone.
Input
The resource name of the controller to be deleted.
Output
No return value.
Bind a controller
Binds a controller. Binding a controller assigns a device identifier to the controller. After binding, the device can then be initialized or configured.
Input
The resource name of the controller 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 a controller
Unbinds a controller. Unbinding a controller removes the device identifier from the controller. This may be required in some cases where the controller 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 controller to be bound.
If set to true, the device identifier is removed (unbound) from the controller. Otherwise, the request will only work if the controller isn't bound to any previous device identifier.
Output
Initialize a controller
Initializes a controller. Controllers need to be initialized before you can start to use them.
Input
The resource name of the controller 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 a controller
Configures a controller. Configuring a controller implies adding some information to the controller such as setting the time zone.
Input
The resource name of the controller 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 a controller
Resetting a device such as a controller 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 controller 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 controller firmware
Updates a controller's firmware. SALTO provides firmware updates when new functionality is available or when we fix a bug.
Input
The resource name of the controller 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.
Generates an authorization token for a controller
Generates an authorization token that allows to connect, authenticate and authorize against a controller.
Input
The resource name of the controller that the authorization token is generated for.
Output
Authorization token to be used for connecting against a controller.
Generate controller firmware download URI
Provides the download URI for the latest firmware bundle for the controller. The returned URI can be used to bring the controller firmwares up to latest.
Input
The resource name of the controller 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.
Create a controller relay
Creates a new controller relay
Input
Resource name of the parent resource where the controller relay is to be created.
The controller relay resource to be created. Client must not set the ControllerRelay.name field.
The controller relay ID to use for this controller relay. In case it's empty the server will autogenerate a unique identifier.
Output
Output only. Resource name of the controller relay. It must have the format of installations/*/controllers/*/relays/*.
Identifies the specific controller relay on the board (1-4). Board type determines which controller relay IDs are actually available for configuration and use.
Extension board address. Values range from 0-15, allowing for up to 16 boards in the system. This field is not applicable for master boards or wall reader extension boards.
Defines the controller relay type, allowing for different controller relay configurations.
Destination output configuration for this controller relay.
Strike configuration for this controller relay.
Create a batch of controller relays
Creates a batch of controller relays. This method allows the creation of multiple controller relays in a single operation.
Input
Resource name of the parent resource where the controller relays are to be created.
The request message specifying the resources to create. A maximum of 100 controller relays can be created in a batch.
Output
The controller relay resources created.
Get a controller relay
Gets an existing controller relay.
Input
The name of the requested controller relay resource.
Output
Output only. Resource name of the controller relay. It must have the format of installations/*/controllers/*/relays/*.
Identifies the specific controller relay on the board (1-4). Board type determines which controller relay IDs are actually available for configuration and use.
Extension board address. Values range from 0-15, allowing for up to 16 boards in the system. This field is not applicable for master boards or wall reader extension boards.
Defines the controller relay type, allowing for different controller relay configurations.
Destination output configuration for this controller relay.
Strike configuration for this controller relay.
List controller relays
Returns a list of controller relays 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 controller relays to return.
How the results should be sorted.
Output
The field name should match the noun relays 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 a controller relay
Updates an existing controller relay.
Input
The controller relay resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Output only. Resource name of the controller relay. It must have the format of installations/*/controllers/*/relays/*.
Identifies the specific controller relay on the board (1-4). Board type determines which controller relay IDs are actually available for configuration and use.
Extension board address. Values range from 0-15, allowing for up to 16 boards in the system. This field is not applicable for master boards or wall reader extension boards.
Defines the controller relay type, allowing for different controller relay configurations.
Destination output configuration for this controller relay.
Strike configuration for this controller relay.
Update a batch of controller relays
Updates a batch of controller relays. This method allows updating multiple controller relays in a single operation.
Input
Resource name of the controller relays to be updated.
The request message specifying the resources to update. A maximum of 100 controller relays can be updated in a batch.
Output
The controller relay resources updated.
Delete a controller relay
Permanently deletes a controller relay. This cannot be undone.
Input
The resource name of the controller relay to be deleted.
Output
No return value.
Delete a batch of controller relays
Permanently deletes a batch of controller relays. This cannot be undone.
Input
Resource name of the controller relays to be deleted.
The request message specifying the resources to delete. A maximum of 100 controller relays can be deleted in a batch.
Output
Back
Access rights
Electronic locks