DirectparameterPage.py

# SPDX-License-Identifier: MIT
#
# The MIT License (MIT)
#
# Copyright (c) <2021> Hottinger Brüel & Kjaer GmbH, Im Tiefen See 45, 64293 Darmstadt, Germany
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

# IO Link Direct Parameter Page 1
# For more information and documentation, please go to https://io-link.com/en/index.php

from saleae.analyzers import AnalyzerFrame

directparameterPage1 = ('MasterCommand',
                        'MasterCycleTime',
                        'MinCycleTime',
                        'M-sequence Capability',
                        'RevisionID',
                        'ProcessDataIn',
                        'ProcessDataOut',
                        'VendorID1 (MSB)',
                        'VendorID2 (LSB)',
                        'DeviceID1 (MSB)',
                        'DeviceID2 (  B)',
                        'DeviceID3 (LSB)',
                        'FunctionID1 (MSB)',
                        'FunctionID2 (LSB)',
                        'reserved',
                        'SystemCommand')

masterCommand = {
    0x5A: 'Fallback',
    0x95: 'MasterIdent',
    0x96: 'DeviceIdent',
    0x97: 'DeviceStartup',
    0x98: 'ProcessDataOutputOperate',
    0x99: 'DeviceOperate',
    0x9A: 'DevicePreoperate',
}

systemCommand = {
    0x01: 'ParamUploadStart',
    0x02: 'ParamUploadEnd',
    0x03: 'ParamDownloadStart',
    0x04: 'ParamDownloadEnd',
    0x05: 'ParamDownloadStore',
    0x06: 'ParamBreak',
    0x80: 'Device reset',
    0x81: 'Application reset',
    0x82: 'Restore factory settings',
}


def printDPP2(frame: AnalyzerFrame):
    addr = frame.data['Addr'][0] & 0xf
    if frame.data['Direction'] == 'Write':
        print("DirectParameter Page2 WRITE to  Addr: " + hex(addr) + " value: " + frame.data['OD'][:4])
    else:
        print("DirectParameter Page2 READ from Addr: " + hex(addr) + " value: " + frame.data['OD'][:4])


def printMasterCommand(frame: AnalyzerFrame):
    val = int(frame.data['OD'][:4], 0)
    print("MasterCommand: " + hex(val) + " (" + masterCommand.get(val, "unknown") + ")")


def printSystemCommand(frame: AnalyzerFrame):
    val = int(frame.data['OD'][:4], 0)
    print("SystemCommand: " + hex(val) + " (" + systemCommand.get(val, "unknown") + ")")


def printDPP1(frame: AnalyzerFrame):
    addr = frame.data['Addr'][0] & 0xf
    if addr == 0 and frame.data['Direction'] == 'Write':
        return printMasterCommand(frame)
    if addr == 15 and frame.data['Direction'] == 'Write':
        return printSystemCommand(frame)

    if frame.data['Direction'] == 'Write':
        print("DirectParameter Page1 WRITE to  Addr: " + hex(addr) + " (" + directparameterPage1[addr] + ") value: " +
              frame.data['OD'][:4])
    else:
        print("DirectParameter Page1 READ from Addr: " + hex(addr) + " (" + directparameterPage1[addr] + ") value: " +
              frame.data['OD'][:4])


def printFrame(frame: AnalyzerFrame):
    try:
        if frame.data['Addr'][0] > 15:
            printDPP2(frame)
        else:
            printDPP1(frame)
    except (KeyError, TypeError):
        print("Cannot decode faulty frame")