Skip to content

send_data_to_wireless_device

send_data_to_wireless_device(
    id: WirelessDeviceId,
    transmit_mode: TransmitMode,
    payload_data: PayloadData,
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    wireless_metadata: Optional[WirelessMetadata] = None,
) -> SendDataToWirelessDeviceResponse

Sends a decrypted application data frame to a device.

Parameters:

  • id (WirelessDeviceId) –

    The ID of the wireless device to receive the data.

  • transmit_mode (TransmitMode) –

    The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

  • wireless_metadata (Optional[WirelessMetadata], default: None ) –

    Metadata about the message request.

Raises:

Source code in docs_src/capo_iot_wireless/_services/io_t_wireless.py
def send_data_to_wireless_device(
    self,
    id: "capo_iot_wireless.types.wireless_device_id.WirelessDeviceId",
    transmit_mode: "capo_iot_wireless.types.transmit_mode.TransmitMode",
    payload_data: "capo_iot_wireless.types.payload_data.PayloadData",
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    wireless_metadata: Optional[
        "capo_iot_wireless.types.wireless_metadata.WirelessMetadata"
    ] = None,
) -> "capo_iot_wireless.types.send_data_to_wireless_device_response.SendDataToWirelessDeviceResponse":
    """<p>Sends a decrypted application data frame to a device.</p>

    Args:
        id: <p>The ID of the wireless device to receive the data.</p>
        transmit_mode: <p>The transmit mode to use to send data to the wireless device. Can be: <code>0</code> for UM (unacknowledge mode) or <code>1</code> for AM (acknowledge mode).</p>
        wireless_metadata: <p>Metadata about the message request.</p>

    Raises:
        capo_iot_wireless.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request.</p>
        capo_iot_wireless.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource does not exist.</p>
        capo_iot_wireless.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed API request rate.</p>
        capo_iot_wireless.errors.validation_exception.ValidationException: <p>The input did not meet the specified constraints.</p>
        capo_iot_wireless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_wireless.types.send_data_to_wireless_device_request.SendDataToWirelessDeviceRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.send_data_to_wireless_device_response.SendDataToWirelessDeviceResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.send_data_to_wireless_device

        output, http_response = (
            capo_iot_wireless._operations.iotwireless.send_data_to_wireless_device.send_data_to_wireless_device(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SendDataToWirelessDevice")
    )
    input_: capo_iot_wireless.types.send_data_to_wireless_device_request.SendDataToWirelessDeviceRequest = {
        "id": id,
        "transmit_mode": transmit_mode,
        "payload_data": payload_data,
    }
    if wireless_metadata is not None:
        input_["wireless_metadata"] = wireless_metadata

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output