{"id":18567139,"url":"https://github.com/vahidzee/hardwar-2019-client","last_synced_at":"2026-05-20T05:33:51.840Z","repository":{"id":68565222,"uuid":"184070953","full_name":"vahidzee/HardWar-2019-Client","owner":"vahidzee","description":"Middleware Client which connects Arduino through Serial Port to a custom TCP server - SUT HardWar 2019 Contest","archived":false,"fork":false,"pushed_at":"2019-05-11T13:46:16.000Z","size":24,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-15T20:09:07.808Z","etag":null,"topics":["arduino","network","python3","serial-port","serial-ports","sharif-university"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vahidzee.png","metadata":{"files":{"readme":"ReadMe.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2019-04-29T12:54:12.000Z","updated_at":"2022-08-17T16:41:59.000Z","dependencies_parsed_at":"2023-02-22T17:00:54.311Z","dependency_job_id":null,"html_url":"https://github.com/vahidzee/HardWar-2019-Client","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/vahidzee/HardWar-2019-Client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahidzee%2FHardWar-2019-Client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahidzee%2FHardWar-2019-Client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahidzee%2FHardWar-2019-Client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahidzee%2FHardWar-2019-Client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vahidzee","download_url":"https://codeload.github.com/vahidzee/HardWar-2019-Client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vahidzee%2FHardWar-2019-Client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270336686,"owners_count":24566779,"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","status":"online","status_checked_at":"2025-08-13T02:00:09.904Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["arduino","network","python3","serial-port","serial-ports","sharif-university"],"created_at":"2024-11-06T22:25:33.664Z","updated_at":"2026-05-20T05:33:46.805Z","avatar_url":"https://github.com/vahidzee.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sharif University of Technology Hardwar 2019 - Arduino Middleware Client\n## Setup\nPython 3.5 or higher is required\n\nFollow the steps bellow:\n1. Clone this repository by running :\n`git clone www.github.com/vahidzee/HardWarClient.git`\n\n2. Go to the cloned directory :\n`cd HardWarClient`\n\n3. Install virtualenv :\n`sudo apt install virtualenv`\n\n4. Create a virtual environment for the project by running : \n`virtualenv --python=python3 venv`\n\n5. Activate your virtual environment by running:\n`source venv/bin/activate`\n\n6. Install Project requirements by running:\n`pip install -r requirements.txt`\n\n7. Install python serial\n`sudo apt-get install python3-serial`\n\n8. Run Project by running:\n`sudo python3 main.py`\n\n## Settings\n### Serial Port Setup\nFirst of all you should find the port your Arduino is connected to by looking under \n`tools \u003e port` in your Arduino sketch application,\nalso you can list all serial ports available on your computer by running\n`python -m serial.tools.list_ports` \n\nAfter finding the serial port your device is connected to, \nenter the port name in `settings.py` as a value of `serial_port_name`,\nyou can also change `serial_baudrate` and `serial_timeout` to your desired values.\n\n### Network Address\nSet `server_address` and `server_port` to announced values.\n\n### Log Settings\nIf `serial_log` is set to `True`, every Serial output of your Arduino device will be displayed in both two running modes.\n\nIf `network_log` is set to `True`, every received data from server will be displayed in both two running modes.\n \n## Usage\n### Running options\nThere are Two Running Options:\n1. Binding Arduino to the network: `python main.py` which binds your Arduino device to the server specified by `server_address` and `server_port` in settings.\n2. Debugging Arduino's Connection: `python main.py debug_arduino` which sends the byte-array set by `arduino_debug_message` in `settings.py` file.\n\n### Accessing Data From Arduino's Side\nEvery data sent to your device is accessible through Arduino's Serial read methods and all your Serial output results will be read by Client Application.\n\n\n## Debugging Windows Problems\n* First of all make sure you're typing `py` instead of `python` to run python applications :D !\n* Make sure you're running this project as an administrator (open your command line application as an administrator)\n* If you're still getting errors while opening the serial port, goto your `device manager` and `disable` and `enable` the serial port your device is connected to without pulling it out.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvahidzee%2Fhardwar-2019-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvahidzee%2Fhardwar-2019-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvahidzee%2Fhardwar-2019-client/lists"}