{"id":20526352,"url":"https://github.com/powerbroker2/pyserialtransfer","last_synced_at":"2025-10-23T17:43:19.673Z","repository":{"id":36470047,"uuid":"224799022","full_name":"PowerBroker2/pySerialTransfer","owner":"PowerBroker2","description":"Python package to transfer data in a fast, reliable, and packetized form","archived":false,"fork":false,"pushed_at":"2024-04-07T12:55:26.000Z","size":160,"stargazers_count":127,"open_issues_count":15,"forks_count":32,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-07T21:41:59.082Z","etag":null,"topics":["arduinos","packet-capturing-libraries","python","robust","serial","serial-communication","serialport","transfer-data","uart","uart-bridge","uart-interface","uart-protocol"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PowerBroker2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-11-29T07:21:24.000Z","updated_at":"2024-04-15T01:39:08.020Z","dependencies_parsed_at":"2024-01-19T21:38:52.214Z","dependency_job_id":"e77121b4-dd4d-4fa4-9405-2e6109bde219","html_url":"https://github.com/PowerBroker2/pySerialTransfer","commit_stats":{"total_commits":110,"total_committers":8,"mean_commits":13.75,"dds":"0.10909090909090913","last_synced_commit":"782c4ab712a530eea797783e01a18941e5227cc3"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerBroker2%2FpySerialTransfer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerBroker2%2FpySerialTransfer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerBroker2%2FpySerialTransfer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerBroker2%2FpySerialTransfer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PowerBroker2","download_url":"https://codeload.github.com/PowerBroker2/pySerialTransfer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457801,"owners_count":20941906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduinos","packet-capturing-libraries","python","robust","serial","serial-communication","serialport","transfer-data","uart","uart-bridge","uart-interface","uart-protocol"],"created_at":"2024-11-15T23:13:50.185Z","updated_at":"2025-10-23T17:43:19.578Z","avatar_url":"https://github.com/PowerBroker2.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pySerialTransfer\r\n[![GitHub version](https://badge.fury.io/gh/PowerBroker2%2FpySerialTransfer.svg)](https://badge.fury.io/gh/PowerBroker2%2FpySerialTransfer) [![PyPI version](https://badge.fury.io/py/pySerialTransfer.svg)](https://badge.fury.io/py/pySerialTransfer)\u003cbr /\u003e\u003cbr /\u003e\r\nPython package to transfer data in a fast, reliable, and packetized form.\r\n\r\nIf using this package to communicate with Arduinos, see https://github.com/PowerBroker2/SerialTransfer for the corresponding and compatible library (also available through the Arduino IDE's Libraries Manager).\r\n\r\n# To Install\r\n```\r\npip install pySerialTransfer\r\n```\r\n\r\n# Example Python Script\r\n```python\r\nimport time\r\nfrom pySerialTransfer import pySerialTransfer as txfer\r\n\r\n\r\nif __name__ == '__main__':\r\n    try:\r\n        link = txfer.SerialTransfer('COM17')\r\n        \r\n        link.open()\r\n        time.sleep(2) # allow some time for the Arduino to completely reset\r\n        \r\n        while True:\r\n            send_size = 0\r\n            \r\n            ###################################################################\r\n            # Send a list\r\n            ###################################################################\r\n            list_ = [1, 3]\r\n            list_size = link.tx_obj(list_)\r\n            send_size += list_size\r\n            \r\n            ###################################################################\r\n            # Send a string\r\n            ###################################################################\r\n            str_ = 'hello'\r\n            str_size = link.tx_obj(str_, send_size) - send_size\r\n            send_size += str_size\r\n            \r\n            ###################################################################\r\n            # Send a float\r\n            ###################################################################\r\n            float_ = 5.234\r\n            float_size = link.tx_obj(float_, send_size) - send_size\r\n            send_size += float_size\r\n            \r\n            ###################################################################\r\n            # Transmit all the data to send in a single packet\r\n            ###################################################################\r\n            link.send(send_size)\r\n            \r\n            ###################################################################\r\n            # Wait for a response and report any errors while receiving packets\r\n            ###################################################################\r\n            while not link.available():\r\n                # A negative value for status indicates an error\r\n                if link.status.value \u003c 0:\r\n                    if link.status == txfer.Status.CRC_ERROR:\r\n                        print('ERROR: CRC_ERROR')\r\n                    elif link.status == txfer.Status.PAYLOAD_ERROR:\r\n                        print('ERROR: PAYLOAD_ERROR')\r\n                    elif link.status == txfer.Status.STOP_BYTE_ERROR:\r\n                        print('ERROR: STOP_BYTE_ERROR')\r\n                    else:\r\n                        print('ERROR: {}'.format(link.status.name))\r\n            \r\n            ###################################################################\r\n            # Parse response list\r\n            ###################################################################\r\n            rec_list_  = link.rx_obj(obj_type=type(list_),\r\n                                     obj_byte_size=list_size,\r\n                                     list_format='i')\r\n            \r\n            ###################################################################\r\n            # Parse response string\r\n            ###################################################################\r\n            rec_str_   = link.rx_obj(obj_type=type(str_),\r\n                                     obj_byte_size=str_size,\r\n                                     start_pos=list_size)\r\n            \r\n            ###################################################################\r\n            # Parse response float\r\n            ###################################################################\r\n            rec_float_ = link.rx_obj(obj_type=type(float_),\r\n                                     obj_byte_size=float_size,\r\n                                     start_pos=(list_size + str_size))\r\n            \r\n            ###################################################################\r\n            # Display the received data\r\n            ###################################################################\r\n            print('SENT: {} {} {}'.format(list_, str_, float_))\r\n            print('RCVD: {} {} {}'.format(rec_list_, rec_str_, rec_float_))\r\n            print(' ')\r\n    \r\n    except KeyboardInterrupt:\r\n        try:\r\n            link.close()\r\n        except:\r\n            pass\r\n    \r\n    except:\r\n        import traceback\r\n        traceback.print_exc()\r\n        \r\n        try:\r\n            link.close()\r\n        except:\r\n            pass\r\n```\r\n\r\n# Example Arduino Sketch\r\n```C++\r\n#include \"SerialTransfer.h\"\r\n\r\n\r\nSerialTransfer myTransfer;\r\n\r\n\r\nvoid setup()\r\n{\r\n  Serial.begin(115200);\r\n  myTransfer.begin(Serial);\r\n}\r\n\r\n\r\nvoid loop()\r\n{\r\n  if(myTransfer.available())\r\n  {\r\n    // send all received data back to Python\r\n    for(uint16_t i=0; i \u003c myTransfer.bytesRead; i++)\r\n      myTransfer.packet.txBuff[i] = myTransfer.packet.rxBuff[i];\r\n    \r\n    myTransfer.sendData(myTransfer.bytesRead);\r\n  }\r\n}\r\n```\r\n\r\n# Example Python Script with Callback Functionality\r\nNote that you can specify many callbacks, but only one per packet ID\r\n```Python\r\nimport time\r\nfrom pySerialTransfer import pySerialTransfer as txfer\r\n\r\n\r\ndef hi():\r\n    '''\r\n    Callback function that will automatically be called by link.tick() whenever\r\n    a packet with ID of 0 is successfully parsed.\r\n    '''\r\n    \r\n    print(\"hi\")\r\n    \r\n'''\r\nlist of callback functions to be called during tick. The index of the function\r\nreference within this list must correspond to the packet ID. For instance, if\r\nyou want to call the function hi() when you parse a packet with an ID of 0, you\r\nwould write the callback list with \"hi\" being in the 0th place of the list:\r\n'''\r\ncallback_list = [ hi ]\r\n\r\n\r\nif __name__ == '__main__':\r\n    try:\r\n        link = txfer.SerialTransfer('COM17')\r\n        \r\n        link.set_callbacks(callback_list)\r\n        link.open()\r\n        time.sleep(2) # allow some time for the Arduino to completely reset\r\n        \r\n        while True:\r\n            link.tick()\r\n    \r\n    except KeyboardInterrupt:\r\n        link.close()\r\n    \r\n    except:\r\n        import traceback\r\n        traceback.print_exc()\r\n        \r\n        link.close()\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpowerbroker2%2Fpyserialtransfer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpowerbroker2%2Fpyserialtransfer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpowerbroker2%2Fpyserialtransfer/lists"}