### ScheduleInform 事件的使用说明 ScheduleInform 事件是 TR-069 协议中一个重要的事件类型，用于设备向 ACS（Auto Configuration Server）报告其状态或请求特定操作。根据协议规范[^1]，当设备完成某些预定任务（如上传、下载等）时，会触发 `TRANSFER COMPLETE` 类型的事件，并调用相关方法通知服务器。 在 TR-069 协议中，`ScheduleInform` 事件通常与 Inform 请求结合使用。以下是关于 `ScheduleInform` 的详细说明和示例代码： #### 1. **事件的基本结构** `ScheduleInform` 事件通过 Inform 请求中的 `EventCode` 字段传递给 ACS。例如，当设备完成某个计划任务时，可以发送以下 EventCode： ```xml <Event> <EventStruct> <EventCode>7 TRANSFER COMPLETE</EventCode> <CommandKey>M Download</CommandKey> </EventStruct> </Event> ``` 此处的 `EventCode` 表示传输已完成，而 `CommandKey` 则指定了具体的任务类型（如下载、上传等）[^1]。 #### 2. **Soap 报文示例** 以下是 `ScheduleInform` 事件的一个完整 Soap 报文示例，展示了设备如何向 ACS 报告任务完成的状态： ```xml <?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:cwmp="urn:dslforum-org:cwmp-1-0"> <SOAP-ENV:Header> <cwmp:ID SOAP-ENV:mustUnderstand="1">API_12345</cwmp:ID> </SOAP-ENV:Header> <SOAP-ENV:Body> <cwmp:Inform> <DeviceId> <Manufacturer>OEMVendor</Manufacturer> <OUI>XXXXXX</OUI> <ProductClass>CPEClass</ProductClass> <SerialNumber>1234567890</SerialNumber> </DeviceId> <Event SOAP-ENC:arrayType="cwmp:EventStruct[1]"> <EventStruct> <EventCode>7 TRANSFER COMPLETE</EventCode> <CommandKey>M Download</CommandKey> </EventStruct> </Event> <MaxEnvelopes>1</MaxEnvelopes> <CurrentTime>2023-03-01T12:00:00Z</CurrentTime> <RetryCount>0</RetryCount> </cwmp:Inform> </SOAP-ENV:Body> </SOAP-ENV:Envelope> ``` #### 3. **错误处理机制** 如果在执行任务期间发生错误，ACS 将通过 `Fault` 报文返回错误信息。根据引用[^2]，TR-069 协议定义了错误码范围为 9001-9005，用于描述参数属性相关的错误。以下是可能的错误场景及其对应的处理方式： - 如果设备未能正确解析任务指令，则需要重新发起 `Inform` 请求。 - 如果任务失败，设备应记录失败原因并将其作为 `CommandKey` 的一部分发送给 ACS。 #### 4. **实现注意事项** - 确保 `EventCode` 和 `CommandKey` 的值符合协议规范。 - 在实际应用中，设备需要支持多种任务类型（如下载、上传等），并通过 `ScheduleInform` 事件向 ACS 报告任务状态。 - 如果任务涉及文件传输，建议使用 `Download` 或 `Upload` 方法配合 `ScheduleInform` 事件。 ### 示例代码：Python 实现 ScheduleInform 请求 以下是一个基于 Python 的简单实现，模拟设备向 ACS 发送 `ScheduleInform` 请求的过程： ```python import requests import xml.etree.ElementTree as ET def create_inform_request(event_code, command_key): envelope = ET.Element("SOAP-ENV:Envelope", attrib={ "xmlns:SOAP-ENV": "http://schemas.xmlsoap.org/soap/envelope/", "xmlns:SOAP-ENC": "http://schemas.xmlsoap.org/soap/encoding/", "xmlns:cwmp": "urn:dslforum-org:cwmp-1-0" }) header = ET.SubElement(envelope, "SOAP-ENV:Header") id_elem = ET.SubElement(header, "cwmp:ID", attrib={"SOAP-ENV:mustUnderstand": "1"}) id_elem.text = "API_12345" body = ET.SubElement(envelope, "SOAP-ENV:Body") inform = ET.SubElement(body, "cwmp:Inform") device_id = ET.SubElement(inform, "DeviceId") ET.SubElement(device_id, "Manufacturer").text = "OEMVendor" ET.SubElement(device_id, "OUI").text = "XXXXXX" ET.SubElement(device_id, "ProductClass").text = "CPEClass" ET.SubElement(device_id, "SerialNumber").text = "1234567890" event = ET.SubElement(inform, "Event", attrib={"SOAP-ENC:arrayType": "cwmp:EventStruct[1]"}) event_struct = ET.SubElement(event, "EventStruct") ET.SubElement(event_struct, "EventCode").text = event_code ET.SubElement(event_struct, "CommandKey").text = command_key ET.SubElement(inform, "MaxEnvelopes").text = "1" ET.SubElement(inform, "CurrentTime").text = "2023-03-01T12:00:00Z" ET.SubElement(inform, "RetryCount").text = "0" return ET.tostring(envelope, encoding="utf-8", method="xml") # 发送请求 url = "http://acs-server.example.com/cwmp" headers = {"Content-Type": "text/xml; charset=utf-8"} payload = create_inform_request("7 TRANSFER COMPLETE", "M Download") response = requests.post(url, data=payload, headers=headers) print(response.text) ```