{"id":37741844,"url":"https://github.com/numat/clickplc","last_synced_at":"2026-01-16T14:10:59.855Z","repository":{"id":27655112,"uuid":"105818039","full_name":"numat/clickplc","owner":"numat","description":"Python driver for Koyo Ethernet ClickPLCs.","archived":false,"fork":false,"pushed_at":"2026-01-15T21:59:59.000Z","size":627,"stargazers_count":25,"open_issues_count":6,"forks_count":12,"subscribers_count":11,"default_branch":"master","last_synced_at":"2026-01-16T01:01:53.079Z","etag":null,"topics":["driver","plc","python"],"latest_commit_sha":null,"homepage":"https://www.automationdirect.com/clickplcs/about-click/features","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/numat.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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-10-04T21:02:06.000Z","updated_at":"2026-01-12T06:50:28.000Z","dependencies_parsed_at":"2023-10-01T18:26:35.750Z","dependency_job_id":"bac1f180-2683-468b-beee-5bc2aedfcc35","html_url":"https://github.com/numat/clickplc","commit_stats":{"total_commits":93,"total_committers":9,"mean_commits":"10.333333333333334","dds":0.6666666666666667,"last_synced_commit":"de4d83869bbdbf2b6cc65ed597bf364098d86b90"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/numat/clickplc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fclickplc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fclickplc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fclickplc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fclickplc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/numat","download_url":"https://codeload.github.com/numat/clickplc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/numat%2Fclickplc/sbom","scorecard":{"id":36666,"data":{"date":"2025-08-04","repo":{"name":"github.com/numat/clickplc","commit":"6a6916b6cd67f4d6982e99a22ab72456ba348a6c"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":3.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/15 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/python-package.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-package.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/numat/clickplc/python-package.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/python-package.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/numat/clickplc/python-package.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:38","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:39","Warn: pipCommand not pinned by hash: .github/workflows/python-package.yml:40","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   3 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-14T20:29:11.498Z","repository_id":27655112,"created_at":"2025-08-14T20:29:11.498Z","updated_at":"2025-08-14T20:29:11.498Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28479170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["driver","plc","python"],"created_at":"2026-01-16T14:10:59.792Z","updated_at":"2026-01-16T14:10:59.843Z","avatar_url":"https://github.com/numat.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"clickplc\n========\n\nPython ≥3.8 driver and command-line tool for [Koyo Ethernet ClickPLCs](https://www.automationdirect.com/adc/Overview/Catalog/Programmable_Controllers/CLICK_Series_PLCs_(Stackable_Micro_Brick)).\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://www.automationdirect.com/microsites/clickplcs/images/expandedclick.jpg\" /\u003e\n\u003c/p\u003e\n\nInstallation\n============\n\n```\npip install clickplc\n```\n\nUsage\n=====\n\n### Command Line\n\n```\n$ clickplc the-plc-ip-address\n```\n\nThis will print all the X, Y, DS, and DF registers to stdout as JSON. You can pipe\nthis as needed. However, you'll likely want the python functionality below.\n\n### Python\n\nThis uses Python ≥3.5's async/await syntax to asynchronously communicate with\na ClickPLC. For example:\n\n```python\nimport asyncio\nfrom clickplc import ClickPLC\n\nasync def get():\n    async with ClickPLC('the-plc-ip-address') as plc:\n        print(await plc.get('df1-df500'))\n\nasyncio.run(get())\n```\n\nThe entire API is `get` and `set`, and takes a range of inputs:\n\n```python\n\u003e\u003e\u003e await plc.get('df1')\n0.0\n\u003e\u003e\u003e await plc.get('df1-df20')\n{'df1': 0.0, 'df2': 0.0, ..., 'df20': 0.0}\n\u003e\u003e\u003e await plc.get('y101-y316')\n{'y101': False, 'y102': False, ..., 'y316': False}\n\n\u003e\u003e\u003e await plc.set('df1', 0.0)  # Sets DF1 to 0.0\n\u003e\u003e\u003e await plc.set('df1', [0.0, 0.0, 0.0])  # Sets DF1-DF3 to 0.0.\n\u003e\u003e\u003e await plc.set('y101', True)  # Sets Y101 to true\n```\n\nCurrently, the following datatypes are supported:\n\n|  |  |  |\n|---|---|---|\n| x | bool | Input point |\n| y | bool | Output point |\n| c | bool | (C)ontrol relay |\n| t | bool | (T)imer |\n| ct | bool | (C)oun(t)er |\n| ds | int16 | (D)ata register, (s)ingle signed int |\n| dd | int32 | (D)ata register, (d)double signed int |\n| df | float | (D)ata register, (f)loating point |\n| td | int16 | (T)ime (d)elay register |\n| ctd | int32 | (C)oun(t)er Current Values, (d)ouble int |\n| sd | int16 | (S)ystem (D)ata register |\n\n### Tags / Nicknames\n\nRecent ClickPLC software provides the ability to export a \"tags file\", which\ncontains all variables with user-assigned nicknames. The tags file can be used\nwith this driver to improve code readability. (Who really wants to think about\nmodbus addresses and register/coil types?)\n\nTo export a tags file, open the ClickPLC software, go to the Address Picker,\nselect \"Display MODBUS address\", and export the file.\n\nOnce you have this file, simply pass the file path to the driver. You can now\n`set` variables by name and `get` all named variables by default.\n\n```python\nasync with ClickPLC('the-plc-ip-address', 'path-to-tags.csv') as plc:\n    await plc.set('my-nickname', True)  # Set variable by nickname\n    print(await plc.get())  # Get all named variables in tags file\n```\n\nAdditionally, the tags file can be used with the commandline tool to provide more informative output:\n```\n$ clickplc the-plc-ip-address tags-filepath\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumat%2Fclickplc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnumat%2Fclickplc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumat%2Fclickplc/lists"}