全部產品
Search
文件中心

IoT Platform:Python指令碼樣本

更新時間:Jun 30, 2024

本文提供Python語言的物模型訊息解析指令碼模板和樣本。

指令碼模板

您可以基於以下Python指令碼模板編寫訊息解析指令碼。

說明 本模板僅適用於資料格式透傳/自訂的產品。
# 將裝置的自訂格式資料轉換為Alink協議的資料,裝置上報資料到物聯網平台時調用。
# 入參: rawData,列表,列表元素取值為int類型,不可為空。
# 出參: jsonObj,字典,不可為空。
def raw_data_to_protocol(rawData):
    jsonObj = {}
    return jsonObj

# 將Alink協議的資料轉換為裝置能識別的格式資料,物聯網平台給裝置下發資料時調用。
# 入參: jsonData,字典,不可為空。
# 出參: rawdata,列表,列表元素取值為int類型且大小為[0, 255]之間,不可為空。
def protocol_to_raw_data(jsonData):
    rawData = []
    return rawData

指令碼編寫注意事項

  • 請避免使用全域變數,否則會造成執行結果不一致。
  • 指令碼中,處理資料採用補碼的方式, [-128, 127]補碼範圍為[0, 255]。例如,-1對應的補碼為255(10進位表示)。
  • 解析裝置上報資料的函數(raw_data_to_protocol)的入參為整型數組。需要通過0xFF進行與操作,擷取其對應的補碼。
  • 解析物聯網平台下發資料的函數(protocol_to_raw_data)的返回結果為數組。數組元素為整型,取值為[0, 255]。

指令碼樣本

以下是基於提交物模型訊息解析指令碼中定義的屬性和通訊協定編寫的指令碼。

物模型訊息中資料類型說明,請參見物模型支援的資料類型。物模型屬性、事件上報資料後,物聯網平台返回的Alink格式響應結果,會通過指令碼解析轉換後返回給裝置。Alink資料格式說明,請參見裝置屬性、事件、服務

# coding=UTF-8
import struct
import common_util

COMMAND_REPORT = 0x00  # 屬性上報。
COMMAND_SET = 0x01  # 屬性設定。
COMMAND_REPORT_REPLY = 0x02  # 上報資料返回結果。
COMMAND_SET_REPLY = 0x03  # 屬性設定裝置返回結果。
COMMAD_UNKOWN = 0xff  # 未知的命令。
ALINK_PROP_REPORT_METHOD = 'thing.event.property.post'  # 物聯網平台Topic,裝置上傳屬性資料到雲端。
ALINK_PROP_SET_METHOD = 'thing.service.property.set'  # 物聯網平台Topic,雲端下發屬性控制指令到裝置端。
SELF_DEFINE_TOPIC_UPDATE_FLAG = '/user/update'  # 自訂Topic:/user/update。
SELF_DEFINE_TOPIC_ERROR_FLAG = '/user/update/error' # 自訂Topic:/user/update/error。


# 樣本資料:
# 裝置上報屬性資料:
# 傳入參數:
#    0x000000000100320100000000
# 輸出結果:
#    {"method":"thing.event.property.post","id":"1","params":{"prop_float":0,"prop_int16":50,"prop_bool":1},"version":"1.0"}
# 屬性設定的返回結果:
# 傳入參數:
#    0x0300223344c8
# 輸出結果:
#    {"code":"200","data":{},"id":"2241348","version":"1.0"}

def raw_data_to_protocol(bytes):
    uint8Array = []
    for byteValue in bytes:
        uint8Array.append(byteValue & 0xff)

    fHead = uint8Array[0]
    jsonMap = {}
    if fHead == COMMAND_REPORT:
        jsonMap['method'] = ALINK_PROP_REPORT_METHOD
        jsonMap['version'] = '1.0'
        jsonMap['id'] = str(bytes_to_int(uint8Array[1:5]))
        params = {}
        params['prop_int16'] = bytes_to_int(uint8Array[5:7])
        params['prop_bool'] = bytes_to_int(uint8Array[7: 8])
        params['prop_float'] = bytes_to_int(uint8Array[8:])
        jsonMap['params'] = params
    elif fHead == COMMAND_SET_REPLY:
        jsonMap['version'] = '1.0'
        jsonMap['id'] = str(bytes_to_int(uint8Array[1:5]))
        jsonMap['code'] = str(bytes_to_int(uint8Array[5:]))
        jsonMap['data'] = {}

    return jsonMap


# 樣本資料:
# 雲端下發屬性設定指令:
# 傳入參數:
#    {"method":"thing.service.property.set","id":"12345","version":"1.0",
#    "params":{"prop_float":123.452, "prop_int16":333, "prop_bool":1}}
# 輸出結果:
#    0x0100003039014d0142f6e76d
# 裝置上報的返回結果:
# 傳入資料:
#    {"method":"thing.event.property.post","id":"12345","version":"1.0","code":200,"data":{}}
# 輸出結果 ->
#    0x0200003039c8
def protocol_to_raw_data(json):
    method = json.get('method', None)
    id = json.get('id', None)
    version = json.get('version', None)
    payload_array = []

    if method == ALINK_PROP_SET_METHOD:
        params = json.get('params')
        prop_float = params.get('prop_float', None)
        prop_int16 = params.get('prop_int16', None)
        prop_bool = params.get('prop_bool', None)

        payload_array = payload_array + int_8_to_byte(COMMAND_SET)
        payload_array = payload_array + int_32_to_byte(int(id))
        payload_array = payload_array + int_16_to_byte(prop_int16)
        payload_array = payload_array + int_8_to_byte(prop_bool)
        payload_array = payload_array + float_to_byte(prop_float)

    elif method == ALINK_PROP_REPORT_METHOD:
        code = json.get('code', None)
        payload_array = payload_array + int_8_to_byte(COMMAND_REPORT_REPLY)
        payload_array = payload_array + int_32_to_byte(int(id))
        payload_array = payload_array + int_8_to_byte(code)
    else:
        code = json.get('code')
        payload_array = payload_array + int_8_to_byte(COMMAD_UNKOWN)
        payload_array = payload_array + int_32_to_byte(int(id))
        payload_array = payload_array + int_8_to_byte(code)

    return payload_array



#  樣本資料:
#  自訂Topic:
#      /user/update,上報資料。
#  輸入參數:
#      topic:/{productKey}/{deviceName}/user/update
#      bytes: 0x000000000100320100000000
#  輸出參數:
#  {
#     "prop_float": 0,
#     "prop_int16": 50,
#     "prop_bool": 1,
#     "topic": "/{productKey}/{deviceName}/user/update"
#   }
def transform_payload(topic, bytes):
    uint8Array = []
    for byteValue in bytes:
        uint8Array.append(byteValue & 0xff)

    jsonMap = {}
    if SELF_DEFINE_TOPIC_ERROR_FLAG in topic:
        jsonMap['topic'] = topic
        jsonMap['errorCode'] = bytes_to_int(uint8Array[0:1])

    elif SELF_DEFINE_TOPIC_UPDATE_FLAG in topic:
        jsonMap['topic'] = topic
        jsonMap['prop_int16'] = bytes_to_int(uint8Array[5:7])
        jsonMap['prop_bool'] = bytes_to_int(uint8Array[7: 8])
        jsonMap['prop_float'] = bytes_to_int(uint8Array[8:])

    return jsonMap


# byte轉成int。
def bytes_to_int(bytes):
    data = ['%02X' % i for i in bytes]
    return int(''.join(data), 16)



# 8位整型轉成byte數組。
def int_8_to_byte(value):
    t_value = '%02X' % value
    if len(t_value) % 2 != 0:
        t_value += '0'

    return hex_string_to_byte_array(t_value)


# 32位整型轉成byte數組。
def int_32_to_byte(value):
    t_value = '%08X' % value
    if len(t_value) % 2 != 0:
        t_value += '0'

    return hex_string_to_byte_array(t_value)


# 16位整型轉成byte數組。
def int_16_to_byte(value):
    t_value = '%04X' % value
    if len(t_value) % 2 != 0:
        t_value += '0'

    return hex_string_to_byte_array(t_value)


# float轉成整型數組。
def float_to_byte(param):
    return hex_string_to_byte_array(struct.pack(">f", param).encode('hex'))


# 16進位字串轉成byte數組。
def hex_string_to_byte_array(str_value):
    if len(str_value) % 2 != 0:
        return None

    cycle = len(str_value) / 2

    pos = 0
    result = []
    for i in range(0, cycle, 1):
        temp_str_value = str_value[pos:pos + 2]
        temp_int_value = int(temp_str_value, base=16)

        result.append(temp_int_value)
        pos += 2
    return result