2022/11/28 - AWS IoT Wireless - 3 new3 updated api methods
Changes This release includes a new feature for customers to calculate the position of their devices by adding three new APIs: UpdateResourcePosition, GetResourcePosition, and GetPositionEstimate.
Get the position information for a given wireless device or a wireless gateway resource. The postion information uses the World Geodetic System (WGS84).
See also: AWS API Documentation
Request Syntax
client.get_resource_position(
ResourceIdentifier='string',
ResourceType='WirelessDevice'|'WirelessGateway'
)
string
[REQUIRED]
The identifier of the resource for which position information is retrieved. It can be the wireless device ID or the wireless gateway ID depending on the resource type.
string
[REQUIRED]
The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.
dict
Response Syntax
{
'GeoJsonPayload': StreamingBody()
}
Response Structure
(dict) --
GeoJsonPayload (:class:`.StreamingBody`) --
The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.
Get estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.
See also: AWS API Documentation
Request Syntax
client.get_position_estimate(
WiFiAccessPoints=[
{
'MacAddress': 'string',
'Rss': 123
},
],
CellTowers={
'Gsm': [
{
'Mcc': 123,
'Mnc': 123,
'Lac': 123,
'GeranCid': 123,
'GsmLocalId': {
'Bsic': 123,
'Bcch': 123
},
'GsmTimingAdvance': 123,
'RxLevel': 123,
'GsmNmr': [
{
'Bsic': 123,
'Bcch': 123,
'RxLevel': 123,
'GlobalIdentity': {
'Lac': 123,
'GeranCid': 123
}
},
]
},
],
'Wcdma': [
{
'Mcc': 123,
'Mnc': 123,
'Lac': 123,
'UtranCid': 123,
'WcdmaLocalId': {
'Uarfcndl': 123,
'Psc': 123
},
'Rscp': 123,
'PathLoss': 123,
'WcdmaNmr': [
{
'Uarfcndl': 123,
'Psc': 123,
'UtranCid': 123,
'Rscp': 123,
'PathLoss': 123
},
]
},
],
'Tdscdma': [
{
'Mcc': 123,
'Mnc': 123,
'Lac': 123,
'UtranCid': 123,
'TdscdmaLocalId': {
'Uarfcn': 123,
'CellParams': 123
},
'TdscdmaTimingAdvance': 123,
'Rscp': 123,
'PathLoss': 123,
'TdscdmaNmr': [
{
'Uarfcn': 123,
'CellParams': 123,
'UtranCid': 123,
'Rscp': 123,
'PathLoss': 123
},
]
},
],
'Lte': [
{
'Mcc': 123,
'Mnc': 123,
'EutranCid': 123,
'Tac': 123,
'LteLocalId': {
'Pci': 123,
'Earfcn': 123
},
'LteTimingAdvance': 123,
'Rsrp': 123,
'Rsrq': ...,
'NrCapable': True|False,
'LteNmr': [
{
'Pci': 123,
'Earfcn': 123,
'EutranCid': 123,
'Rsrp': 123,
'Rsrq': ...
},
]
},
],
'Cdma': [
{
'SystemId': 123,
'NetworkId': 123,
'BaseStationId': 123,
'RegistrationZone': 123,
'CdmaLocalId': {
'PnOffset': 123,
'CdmaChannel': 123
},
'PilotPower': 123,
'BaseLat': ...,
'BaseLng': ...,
'CdmaNmr': [
{
'PnOffset': 123,
'CdmaChannel': 123,
'PilotPower': 123,
'BaseStationId': 123
},
]
},
]
},
Ip={
'IpAddress': 'string'
},
Gnss={
'Payload': 'string',
'CaptureTime': ...,
'CaptureTimeAccuracy': ...,
'AssistPosition': [
...,
],
'AssistAltitude': ...,
'Use2DSolver': True|False
},
Timestamp=datetime(2015, 1, 1)
)
list
Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.
(dict) --
Wi-Fi access point.
MacAddress (string) -- [REQUIRED]
Wi-Fi MAC Address.
Rss (integer) -- [REQUIRED]
Recived signal strength of the WLAN measurement data.
dict
Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.
Gsm (list) --
GSM object information.
(dict) --
GSM object.
Mcc (integer) -- [REQUIRED]
Mobile Country Code.
Mnc (integer) -- [REQUIRED]
Mobile Network Code.
Lac (integer) -- [REQUIRED]
Location area code.
GeranCid (integer) -- [REQUIRED]
GERAN (GSM EDGE Radio Access Network) Cell Global Identifier.
GsmLocalId (dict) --
GSM local identification (local ID) information.
Bsic (integer) -- [REQUIRED]
GSM base station identity code (BSIC).
Bcch (integer) -- [REQUIRED]
GSM broadcast control channel.
GsmTimingAdvance (integer) --
Timing advance value, which corresponds to the length of time a signal takes to reach the base station from a mobile phone.
RxLevel (integer) --
Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).
GsmNmr (list) --
GSM object for network measurement reports.
(dict) --
GSM object for network measurement reports.
Bsic (integer) -- [REQUIRED]
GSM base station identity code (BSIC).
Bcch (integer) -- [REQUIRED]
GSM broadcast control channel.
RxLevel (integer) --
Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).
GlobalIdentity (dict) --
Global identity information of the GSM object.
Lac (integer) -- [REQUIRED]
Location area code of the global identity.
GeranCid (integer) -- [REQUIRED]
GERAN (GSM EDGE Radio Access Network) cell global identifier.
Wcdma (list) --
WCDMA object information.
(dict) --
WCDMA.
Mcc (integer) -- [REQUIRED]
Mobile Country Code.
Mnc (integer) -- [REQUIRED]
Mobile Network Code.
Lac (integer) --
Location Area Code.
UtranCid (integer) -- [REQUIRED]
UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.
WcdmaLocalId (dict) --
WCDMA local ID information.
Uarfcndl (integer) -- [REQUIRED]
WCDMA UTRA Absolute RF Channel Number downlink.
Psc (integer) -- [REQUIRED]
Primary Scrambling Code.
Rscp (integer) --
Received Signal Code Power (signal power) (dBm).
PathLoss (integer) --
Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.
WcdmaNmr (list) --
WCDMA object for network measurement reports.
(dict) --
Network Measurement Reports.
Uarfcndl (integer) -- [REQUIRED]
WCDMA UTRA Absolute RF Channel Number downlink.
Psc (integer) -- [REQUIRED]
Primary Scrambling Code.
UtranCid (integer) -- [REQUIRED]
UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.
Rscp (integer) --
Received Signal Code Power (signal power) (dBm)
PathLoss (integer) --
Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.
Tdscdma (list) --
TD-SCDMA object information.
(dict) --
TD-SCDMA object.
Mcc (integer) -- [REQUIRED]
Mobile Country Code.
Mnc (integer) -- [REQUIRED]
Mobile Network Code.
Lac (integer) --
Location Area Code.
UtranCid (integer) -- [REQUIRED]
UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.
TdscdmaLocalId (dict) --
TD-SCDMA local identification (local ID) information.
Uarfcn (integer) -- [REQUIRED]
TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number (UARFCN).
CellParams (integer) -- [REQUIRED]
Cell parameters for TD-SCDMA.
TdscdmaTimingAdvance (integer) --
TD-SCDMA Timing advance.
Rscp (integer) --
Signal power of the received signal (Received Signal Code Power), measured in decibel-milliwatts (dBm).
PathLoss (integer) --
Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.
TdscdmaNmr (list) --
TD-SCDMA object for network measurement reports.
(dict) --
TD-SCDMA object for network measurement reports.
Uarfcn (integer) -- [REQUIRED]
TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number.
CellParams (integer) -- [REQUIRED]
Cell parameters for TD-SCDMA network measurement reports object.
UtranCid (integer) --
UTRAN (UMTS Terrestrial Radio Access Network) cell global identifier.
Rscp (integer) --
Code power of the received signal, measured in decibel-milliwatts (dBm).
PathLoss (integer) --
Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.
Lte (list) --
LTE object information.
(dict) --
LTE object.
Mcc (integer) -- [REQUIRED]
Mobile Country Code.
Mnc (integer) -- [REQUIRED]
Mobile Network Code.
EutranCid (integer) -- [REQUIRED]
E-UTRAN (Evolved Universal Terrestrial Radio Access Network) Cell Global Identifier.
Tac (integer) --
LTE tracking area code.
LteLocalId (dict) --
LTE local identification (local ID) information.
Pci (integer) -- [REQUIRED]
Physical cell ID.
Earfcn (integer) -- [REQUIRED]
Evolved universal terrestrial radio access (E-UTRA) absolute radio frequency channel number (FCN).
LteTimingAdvance (integer) --
LTE timing advance.
Rsrp (integer) --
Signal power of the reference signal received, measured in dBm (decibel-milliwatts).
Rsrq (float) --
Signal quality of the reference Signal received, measured in decibels (dB).
NrCapable (boolean) --
Parameter that determines whether the LTE object is capable of supporting NR (new radio).
LteNmr (list) --
LTE object for network measurement reports.
(dict) --
LTE object for network measurement reports.
Pci (integer) -- [REQUIRED]
Physical cell ID.
Earfcn (integer) -- [REQUIRED]
E-UTRA (Evolved universal terrestrial Radio Access) absolute radio frequency channel Number (EARFCN).
EutranCid (integer) -- [REQUIRED]
E-UTRAN (Evolved Universal Terrestrial Radio Access Network) cell global identifier (EUTRANCID).
Rsrp (integer) --
Signal power of the reference signal received, measured in dBm (decibel-milliwatts).
Rsrq (float) --
Signal quality of the reference Signal received, measured in decibels (dB).
Cdma (list) --
CDMA object information.
(dict) --
CDMA (Code-division multiple access) object.
SystemId (integer) -- [REQUIRED]
CDMA system ID (SID).
NetworkId (integer) -- [REQUIRED]
CDMA network ID (NID).
BaseStationId (integer) -- [REQUIRED]
CDMA base station ID (BSID).
RegistrationZone (integer) --
CDMA registration zone (RZ).
CdmaLocalId (dict) --
CDMA local identification (local ID) parameters.
PnOffset (integer) -- [REQUIRED]
Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.
CdmaChannel (integer) -- [REQUIRED]
CDMA channel information.
PilotPower (integer) --
Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).
BaseLat (float) --
CDMA base station latitude in degrees.
BaseLng (float) --
CDMA base station longtitude in degrees.
CdmaNmr (list) --
CDMA network measurement reports.
(dict) --
CDMA object for network measurement reports.
PnOffset (integer) -- [REQUIRED]
Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.
CdmaChannel (integer) -- [REQUIRED]
CDMA channel information.
PilotPower (integer) --
Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).
BaseStationId (integer) --
CDMA base station ID (BSID).
dict
Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.
IpAddress (string) -- [REQUIRED]
IP address information.
dict
Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.
Payload (string) -- [REQUIRED]
Payload that contains the GNSS scan result, or NAV message, in hexadecimal notation.
CaptureTime (float) --
Optional parameter that gives an estimate of the time when the GNSS scan information is taken, in seconds GPS time (GPST). If capture time is not specified, the local server time is used.
CaptureTimeAccuracy (float) --
Optional value that gives the capture time estimate accuracy, in seconds. If capture time accuracy is not specified, default value of 300 is used.
AssistPosition (list) --
Optional assistance position information, specified using latitude and longitude values in degrees. The co-ordinates are inside the WGS84 reference frame.
(float) --
AssistAltitude (float) --
Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid.
Use2DSolver (boolean) --
Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.
datetime
Optional information that specifies the time when the position information will be resolved. It uses the UNIX timestamp format. If not specified, the time at which the request was received will be used.
dict
Response Syntax
{
'GeoJsonPayload': StreamingBody()
}
Response Structure
(dict) --
GeoJsonPayload (:class:`.StreamingBody`) --
The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.
Update the position information of a given wireless device or a wireless gateway resource. The postion coordinates are based on the World Geodetic System (WGS84).
See also: AWS API Documentation
Request Syntax
client.update_resource_position(
ResourceIdentifier='string',
ResourceType='WirelessDevice'|'WirelessGateway',
GeoJsonPayload=b'bytes'|file
)
string
[REQUIRED]
The identifier of the resource for which position information is updated. It can be the wireless device ID or the wireless gateway ID depending on the resource type.
string
[REQUIRED]
The type of resource for which position information is updated, which can be a wireless device or a wireless gateway.
bytes or seekable file-like object
The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.
dict
Response Syntax
{}
Response Structure
(dict) --
{'LoRaWAN': {'FPorts': {'Applications': [{'DestinationName': 'string',
'FPort': 'integer',
'Type': 'SemtechGeolocation'}]}},
'Positioning': 'Enabled | Disabled'}
Provisions a wireless device.
See also: AWS API Documentation
Request Syntax
client.create_wireless_device(
Type='Sidewalk'|'LoRaWAN',
Name='string',
Description='string',
DestinationName='string',
ClientRequestToken='string',
LoRaWAN={
'DevEui': 'string',
'DeviceProfileId': 'string',
'ServiceProfileId': 'string',
'OtaaV1_1': {
'AppKey': 'string',
'NwkKey': 'string',
'JoinEui': 'string'
},
'OtaaV1_0_x': {
'AppKey': 'string',
'AppEui': 'string',
'GenAppKey': 'string'
},
'AbpV1_1': {
'DevAddr': 'string',
'SessionKeys': {
'FNwkSIntKey': 'string',
'SNwkSIntKey': 'string',
'NwkSEncKey': 'string',
'AppSKey': 'string'
},
'FCntStart': 123
},
'AbpV1_0_x': {
'DevAddr': 'string',
'SessionKeys': {
'NwkSKey': 'string',
'AppSKey': 'string'
},
'FCntStart': 123
},
'FPorts': {
'Fuota': 123,
'Multicast': 123,
'ClockSync': 123,
'Positioning': {
'ClockSync': 123,
'Stream': 123,
'Gnss': 123
},
'Applications': [
{
'FPort': 123,
'Type': 'SemtechGeolocation',
'DestinationName': 'string'
},
]
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Positioning='Enabled'|'Disabled'
)
string
[REQUIRED]
The wireless device type.
string
The name of the new resource.
string
The description of the new resource.
string
[REQUIRED]
The name of the destination to assign to the new wireless device.
string
Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.
This field is autopopulated if not provided.
dict
The device configuration information to use to create the wireless device.
DevEui (string) --
The DevEUI value.
DeviceProfileId (string) --
The ID of the device profile for the new wireless device.
ServiceProfileId (string) --
The ID of the service profile.
OtaaV1_1 (dict) --
OTAA device object for v1.1 for create APIs
AppKey (string) --
The AppKey value.
NwkKey (string) --
The NwkKey value.
JoinEui (string) --
The JoinEUI value.
OtaaV1_0_x (dict) --
OTAA device object for create APIs for v1.0.x
AppKey (string) --
The AppKey value.
AppEui (string) --
The AppEUI value.
GenAppKey (string) --
The GenAppKey value.
AbpV1_1 (dict) --
ABP device object for create APIs for v1.1
DevAddr (string) --
The DevAddr value.
SessionKeys (dict) --
Session keys for ABP v1.1
FNwkSIntKey (string) --
The FNwkSIntKey value.
SNwkSIntKey (string) --
The SNwkSIntKey value.
NwkSEncKey (string) --
The NwkSEncKey value.
AppSKey (string) --
The AppSKey value.
FCntStart (integer) --
The FCnt init value.
AbpV1_0_x (dict) --
LoRaWAN object for create APIs
DevAddr (string) --
The DevAddr value.
SessionKeys (dict) --
Session keys for ABP v1.0.x
NwkSKey (string) --
The NwkSKey value.
AppSKey (string) --
The AppSKey value.
FCntStart (integer) --
The FCnt init value.
FPorts (dict) --
List of FPort assigned for different LoRaWAN application packages to use
Fuota (integer) --
The Fport value.
Multicast (integer) --
The Fport value.
ClockSync (integer) --
The Fport value.
Positioning (dict) --
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
ClockSync (integer) --
The Fport value.
Stream (integer) --
The Fport value.
Gnss (integer) --
The Fport value.
Applications (list) --
Optional LoRaWAN application information, which can be used for geolocation.
(dict) --
LoRaWAN application configuration, which can be used to perform geolocation.
FPort (integer) --
The Fport value.
Type (string) --
Application type, which can be specified to obtain real-time position information of your LoRaWAN device.
DestinationName (string) --
The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
list
The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.
(dict) --
A simple label consisting of a customer-defined key-value pair
Key (string) -- [REQUIRED]
The tag's key value.
Value (string) -- [REQUIRED]
The tag's value.
string
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
dict
Response Syntax
{
'Arn': 'string',
'Id': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name of the new resource.
Id (string) --
The ID of the new wireless device.
{'LoRaWAN': {'FPorts': {'Applications': [{'DestinationName': 'string',
'FPort': 'integer',
'Type': 'SemtechGeolocation'}]}},
'Positioning': 'Enabled | Disabled'}
Gets information about a wireless device.
See also: AWS API Documentation
Request Syntax
client.get_wireless_device(
Identifier='string',
IdentifierType='WirelessDeviceId'|'DevEui'|'ThingName'|'SidewalkManufacturingSn'
)
string
[REQUIRED]
The identifier of the wireless device to get.
string
[REQUIRED]
The type of identifier used in identifier.
dict
Response Syntax
{
'Type': 'Sidewalk'|'LoRaWAN',
'Name': 'string',
'Description': 'string',
'DestinationName': 'string',
'Id': 'string',
'Arn': 'string',
'ThingName': 'string',
'ThingArn': 'string',
'LoRaWAN': {
'DevEui': 'string',
'DeviceProfileId': 'string',
'ServiceProfileId': 'string',
'OtaaV1_1': {
'AppKey': 'string',
'NwkKey': 'string',
'JoinEui': 'string'
},
'OtaaV1_0_x': {
'AppKey': 'string',
'AppEui': 'string',
'GenAppKey': 'string'
},
'AbpV1_1': {
'DevAddr': 'string',
'SessionKeys': {
'FNwkSIntKey': 'string',
'SNwkSIntKey': 'string',
'NwkSEncKey': 'string',
'AppSKey': 'string'
},
'FCntStart': 123
},
'AbpV1_0_x': {
'DevAddr': 'string',
'SessionKeys': {
'NwkSKey': 'string',
'AppSKey': 'string'
},
'FCntStart': 123
},
'FPorts': {
'Fuota': 123,
'Multicast': 123,
'ClockSync': 123,
'Positioning': {
'ClockSync': 123,
'Stream': 123,
'Gnss': 123
},
'Applications': [
{
'FPort': 123,
'Type': 'SemtechGeolocation',
'DestinationName': 'string'
},
]
}
},
'Sidewalk': {
'AmazonId': 'string',
'SidewalkId': 'string',
'SidewalkManufacturingSn': 'string',
'DeviceCertificates': [
{
'SigningAlg': 'Ed25519'|'P256r1',
'Value': 'string'
},
]
},
'Positioning': 'Enabled'|'Disabled'
}
Response Structure
(dict) --
Type (string) --
The wireless device type.
Name (string) --
The name of the resource.
Description (string) --
The description of the resource.
DestinationName (string) --
The name of the destination to which the device is assigned.
Id (string) --
The ID of the wireless device.
Arn (string) --
The Amazon Resource Name of the resource.
ThingName (string) --
The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.
ThingArn (string) --
The ARN of the thing associated with the wireless device.
LoRaWAN (dict) --
Information about the wireless device.
DevEui (string) --
The DevEUI value.
DeviceProfileId (string) --
The ID of the device profile for the new wireless device.
ServiceProfileId (string) --
The ID of the service profile.
OtaaV1_1 (dict) --
OTAA device object for v1.1 for create APIs
AppKey (string) --
The AppKey value.
NwkKey (string) --
The NwkKey value.
JoinEui (string) --
The JoinEUI value.
OtaaV1_0_x (dict) --
OTAA device object for create APIs for v1.0.x
AppKey (string) --
The AppKey value.
AppEui (string) --
The AppEUI value.
GenAppKey (string) --
The GenAppKey value.
AbpV1_1 (dict) --
ABP device object for create APIs for v1.1
DevAddr (string) --
The DevAddr value.
SessionKeys (dict) --
Session keys for ABP v1.1
FNwkSIntKey (string) --
The FNwkSIntKey value.
SNwkSIntKey (string) --
The SNwkSIntKey value.
NwkSEncKey (string) --
The NwkSEncKey value.
AppSKey (string) --
The AppSKey value.
FCntStart (integer) --
The FCnt init value.
AbpV1_0_x (dict) --
LoRaWAN object for create APIs
DevAddr (string) --
The DevAddr value.
SessionKeys (dict) --
Session keys for ABP v1.0.x
NwkSKey (string) --
The NwkSKey value.
AppSKey (string) --
The AppSKey value.
FCntStart (integer) --
The FCnt init value.
FPorts (dict) --
List of FPort assigned for different LoRaWAN application packages to use
Fuota (integer) --
The Fport value.
Multicast (integer) --
The Fport value.
ClockSync (integer) --
The Fport value.
Positioning (dict) --
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
ClockSync (integer) --
The Fport value.
Stream (integer) --
The Fport value.
Gnss (integer) --
The Fport value.
Applications (list) --
Optional LoRaWAN application information, which can be used for geolocation.
(dict) --
LoRaWAN application configuration, which can be used to perform geolocation.
FPort (integer) --
The Fport value.
Type (string) --
Application type, which can be specified to obtain real-time position information of your LoRaWAN device.
DestinationName (string) --
The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
Sidewalk (dict) --
Sidewalk device object.
AmazonId (string) --
The Sidewalk Amazon ID.
SidewalkId (string) --
The sidewalk device identification.
SidewalkManufacturingSn (string) --
The Sidewalk manufacturing series number.
DeviceCertificates (list) --
The sidewalk device certificates for Ed25519 and P256r1.
(dict) --
List of sidewalk certificates.
SigningAlg (string) --
The certificate chain algorithm provided by sidewalk.
Value (string) --
The value of the chosen sidewalk certificate.
Positioning (string) --
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
{'LoRaWAN': {'FPorts': {'Applications': [{'DestinationName': 'string',
'FPort': 'integer',
'Type': 'SemtechGeolocation'}]}},
'Positioning': 'Enabled | Disabled'}
Updates properties of a wireless device.
See also: AWS API Documentation
Request Syntax
client.update_wireless_device(
Id='string',
DestinationName='string',
Name='string',
Description='string',
LoRaWAN={
'DeviceProfileId': 'string',
'ServiceProfileId': 'string',
'AbpV1_1': {
'FCntStart': 123
},
'AbpV1_0_x': {
'FCntStart': 123
},
'FPorts': {
'Positioning': {
'ClockSync': 123,
'Stream': 123,
'Gnss': 123
},
'Applications': [
{
'FPort': 123,
'Type': 'SemtechGeolocation',
'DestinationName': 'string'
},
]
}
},
Positioning='Enabled'|'Disabled'
)
string
[REQUIRED]
The ID of the resource to update.
string
The name of the new destination for the device.
string
The new name of the resource.
string
A new description of the resource.
dict
The updated wireless device's configuration.
DeviceProfileId (string) --
The ID of the device profile for the wireless device.
ServiceProfileId (string) --
The ID of the service profile.
AbpV1_1 (dict) --
ABP device object for update APIs for v1.1
FCntStart (integer) --
The FCnt init value.
AbpV1_0_x (dict) --
ABP device object for update APIs for v1.0.x
FCntStart (integer) --
The FCnt init value.
FPorts (dict) --
FPorts object for the positioning information of the device.
Positioning (dict) --
Positioning FPorts for the ClockSync, Stream, and GNSS functions.
ClockSync (integer) --
The Fport value.
Stream (integer) --
The Fport value.
Gnss (integer) --
The Fport value.
Applications (list) --
LoRaWAN application, which can be used for geolocation by activating positioning.
(dict) --
LoRaWAN application configuration, which can be used to perform geolocation.
FPort (integer) --
The Fport value.
Type (string) --
Application type, which can be specified to obtain real-time position information of your LoRaWAN device.
DestinationName (string) --
The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
string
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
dict
Response Syntax
{}
Response Structure
(dict) --