mouse.py

import hidparser
from hidparser.UsagePages import GenericDesktop, Button


if __name__ == '__main__':
    mouse = bytes([
        0x05, 0x01,  # USAGE_PAGE (Generic Desktop)
        0x09, 0x02,  # USAGE (Mouse)
        0xa1, 0x01,  # COLLECTION (Application)
        0x09, 0x01,  #   USAGE (Pointer)
        0xa1, 0x00,  #   COLLECTION (Physical)
        0x05, 0x09,  #     USAGE_PAGE (Button)
        0x19, 0x01,  #     USAGE_MINIMUM (Button 1)
        0x29, 0x03,  #     USAGE_MAXIMUM (Button 3)
        0x15, 0x00,  #     LOGICAL_MINIMUM (0)
        0x25, 0x01,  #     LOGICAL_MAXIMUM (1)
        0x95, 0x03,  #     REPORT_COUNT (3)
        0x75, 0x01,  #     REPORT_SIZE (1)
        0x81, 0x02,  #     INPUT (Data,Var,Abs)
        0x95, 0x01,  #     REPORT_COUNT (1)
        0x75, 0x05,  #     REPORT_SIZE (5)
        0x81, 0x03,  #     INPUT (Cnst,Var,Abs)
        0x05, 0x01,  #     USAGE_PAGE (Generic Desktop)
        0x09, 0x30,  #     USAGE (X)
        0x09, 0x31,  #     USAGE (Y)
        0x15, 0x81,  #     LOGICAL_MINIMUM (-127)
        0x25, 0x7f,  #     LOGICAL_MAXIMUM (127)
        0x75, 0x08,  #     REPORT_SIZE (8)
        0x95, 0x02,  #     REPORT_COUNT (2)
        0x81, 0x06,  #     INPUT (Data,Var,Rel)
        0xc0,        #   END_COLLECTION
        0xc0         # END_COLLECTION
    ])

    # Todo return a more useful Device object instead of a "builder"
    # This returns a Device
    mouse_from_desc = hidparser.parse(mouse)

    # Alternatively, create a mouse device through API instead of parsing bytes
    mouse_from_api = hidparser.Device()

    # TODO accessing the collections by Usage could be cleaned up some how
    # Index 0 is used as a fallback when no ReportID Items are used
    # otherwise, Report ID must start at 1

    mouse_from_api = hidparser.Device(
        hidparser.Collection(
            usage=GenericDesktop.MOUSE,
            items=hidparser.Collection(
                usage=GenericDesktop.POINTER,
                items=[
                    hidparser.Report(
                        report_type=hidparser.ReportType.INPUT,
                        usages=hidparser.UsageRange(
                            minimum=Button(1),
                            maximum=Button(3)
                        ).get_range(),
                        size=1,
                        count=3,
                        logical_range=(0, 1),
                        flags=hidparser.ReportFlags.VARIABLE
                    ),
                    hidparser.Report(
                        report_type=hidparser.ReportType.INPUT,
                        usages=[],
                        size=5,
                        count=1,
                        flags=hidparser.ReportFlags.CONSTANT | hidparser.ReportFlags.VARIABLE
                    ),
                    hidparser.Report(
                        report_type=hidparser.ReportType.INPUT,
                        usages=[
                            GenericDesktop.X,
                            GenericDesktop.Y
                        ],
                        size=8,
                        count=2,
                        logical_range=(-127, 127),
                        flags=hidparser.ReportFlags.VARIABLE | hidparser.ReportFlags.RELATIVE
                    )
                ]
            )
        )
    )

    # Read from the physical device
    data = bytes([0x00, 0x12, 0x34])
    # Deserialize the data and populate the object members
    mouse_from_api.deserialize(data)

    # Read x,y from mouse
    pointer = mouse_from_api.reports[0].inputs.mouse.pointer
    print("pointer: {}, {}".format(pointer.x, pointer.y))
    # pointer 18.0, 52.0

    # The pass is for me to set a break point, so i can inspect the ds3 object with my debugger
    pass