Gateways
Gateways are hardware devices that provide a link between networks that use different base protocols. They are intended for those electronic locks where online connectivity is needed.
This service is responsible for managing gateway resources.
Resource name of the gateway. It must have the format of installations/*/gateways/*. For example: installations/surelock-homes-hq/gateways/conan-doyle.
Display name of the gateway.
Indicates whether this gateway has been initialized or not. This field cannot be modified using a standard UpdateGateway operation. To change the value of this field, you must call InitializeGateway. 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 gateway is connected or not. It's considered connected if the gateway has successfully established communication with the MQTT server.
Ethernet network settings for a gateway
WiFi network settings for a gateway
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
IPv4 (Internet Protocol version 4) settings of an ethernet network.
DNS settings of an ethernet network.
IPv4 (Internet Protocol version 4) settings of a WiFi network.
DNS settings of a WiFi network.
Service set identifier of a WiFi network. An SSID is a 32-character unique identifier attached to the header of packets that are sent over a Wireless Local Area Network. SSIDs serve as "network names" and are typically human readable.
Password to be used to authenticate on a WiFi network.
IP address If unset, an automatic value given by the network will be used.
Subnet mask is expressed in dot-decimal notation like an address. For example: 255.255.255.0 is the subnet mask for the prefix 198.51.100.0/24. If unset, an automatic value given by the network will be used.
Default network router's IP address If unset, an automatic value given by the network will be used.
DNS server IP addresses. The order of the elements in this list will mark priorities. For example: the first element will be primary DNS and the second element will be secondary DNS. If empty, an automatic DNS address given by the network will be used.
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.
Firmware revision of a specific firmware number and version.
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 gateway object
Resource name of the gateway. It must have the format of installations/*/gateways/*. For example: installations/surelock-homes-hq/gateways/conan-doyle.
Display name of the gateway.
Indicates whether this gateway has been initialized or not. This field cannot be modified using a standard UpdateGateway operation. To change the value of this field, you must call InitializeGateway. 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 gateway is connected or not. It's considered connected if the gateway has successfully established communication with the MQTT server.
Ethernet network settings for a gateway
WiFi network settings for a gateway
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
Create a gateway
Creates a new gateway
Input
Resource name of the parent resource where to create the gateway.
The gateway resource to be created. Client must not set the Gateway.name field.
The gateway ID to use for this gateway. In case it's empty the server will autogenerate a unique identifier.
Output
Resource name of the gateway. It must have the format of installations/*/gateways/*.
Display name of the gateway.
Indicates whether this gateway has been initialized or not. This field cannot be modified using a standard UpdateGateway operation. To change the value of this field, you must call InitializeGateway. 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 gateway is connected or not. It's considered connected if the gateway has successfully established communication with the MQTT server.
Ethernet network settings for a gateway
WiFi network settings for a gateway
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
Get a gateway
Gets an existing gateway.
Input
The name of the requested gateway resource.
Output
Resource name of the gateway. It must have the format of installations/*/gateways/*.
Display name of the gateway.
Indicates whether this gateway has been initialized or not. This field cannot be modified using a standard UpdateGateway operation. To change the value of this field, you must call InitializeGateway. 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 gateway is connected or not. It's considered connected if the gateway has successfully established communication with the MQTT server.
Ethernet network settings for a gateway
WiFi network settings for a gateway
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
List gateways
Returns a list of gateways 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 gateways to return.
How the results should be sorted.
Output
The field name should match the noun gateways 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 gateway
Updates an existing gateway.
Input
The gateway resource which replaces the resource on the server.
The update mask applied to the resource.
Output
Resource name of the gateway. It must have the format of installations/*/gateways/*.
Display name of the gateway.
Indicates whether this gateway has been initialized or not. This field cannot be modified using a standard UpdateGateway operation. To change the value of this field, you must call InitializeGateway. 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 gateway is connected or not. It's considered connected if the gateway has successfully established communication with the MQTT server.
Ethernet network settings for a gateway
WiFi network settings for a gateway
Globally unique identifier that is used across all devices manufactured by SALTO, including gateways, extenders, encoders and so on.
Delete a gateway
Permanently deletes a gateway. This cannot be undone.
Input
The resource name of the gateway to be deleted.
Output
No return value.
Bind a gateway
Binds a gateway. Binding a gateway assigns a device identifier to the gateway. After binding, the device can then be initialized or configured.
Input
The resource name of the gateway 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 gateway
Unbinds a gateway. Unbinding a gateway removes the device identifier from the gateway. This may be required in some cases where the gateway 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 gateway to be unbound.
If set to true, the device identifier is removed (unbound) from the gateway. Otherwise, the request will only work if the gateway isn't bound to any previous device identifier.
Output
Initialize a gateway
Initializes a gateway. Gateways need to be initialized before you can start to use them.
Input
The resource name of the gateway 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 gateway
Configures a gateway. Configuring a gateway implies adding some information to the gateway such as setting the time zone.
Input
The resource name of the gateway 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 gateway
Resetting a device such as a gateway 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 gateway 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 gateway firmware
Updates a gateway's firmware. SALTO provides firmware updates when new functionality is available or when we fix a bug.
Input
The resource name of the gateway 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 gateway
Generates an authorization token that allows to connect, authenticate and authorize against a gateway.
Input
The resource name of the gateway that the authorization token is generated for.
Output
Authorization token to be used for connecting against a gateway.
Generate gateway firmware download URI
Provides the download URI for the latest firmware bundle for the gateway. The returned URI can be used to bring the gateway firmwares up to latest.
Input
The resource name of the gateway 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
Extenders
Installations