{"id":15442913,"url":"https://github.com/hachibeedi/irkit","last_synced_at":"2025-04-19T20:13:06.700Z","repository":{"id":19054659,"uuid":"22280964","full_name":"hachibeeDI/IRKit","owner":"hachibeeDI","description":"IRKit api client kit and command line interface","archived":false,"fork":false,"pushed_at":"2023-05-22T21:34:26.000Z","size":46,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T01:42:11.388Z","etag":null,"topics":["cli-command","irkit","python","python-3"],"latest_commit_sha":null,"homepage":"","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/hachibeeDI.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":"2014-07-26T07:30:25.000Z","updated_at":"2018-12-12T09:30:46.000Z","dependencies_parsed_at":"2024-12-03T18:39:25.231Z","dependency_job_id":"aef140bb-6712-4363-9e9b-50c521fa0c60","html_url":"https://github.com/hachibeeDI/IRKit","commit_stats":{"total_commits":44,"total_committers":2,"mean_commits":22.0,"dds":"0.022727272727272707","last_synced_commit":"d9bd6b1e67376345bac2f44597fbc0edcd780576"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hachibeeDI%2FIRKit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hachibeeDI%2FIRKit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hachibeeDI%2FIRKit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hachibeeDI%2FIRKit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hachibeeDI","download_url":"https://codeload.github.com/hachibeeDI/IRKit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249788751,"owners_count":21325760,"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":["cli-command","irkit","python","python-3"],"created_at":"2024-10-01T19:31:32.979Z","updated_at":"2025-04-19T20:13:06.672Z","avatar_url":"https://github.com/hachibeeDI.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IRKit api interface for python\n\n## What is IRKit?\n\nThat is kind of a learning remote control system which has HTTP API interface.\n\nDetails is http://getirkit.com/\n\n\n## install\n\n```bash\n$ pip install irkit\n```\n\n\n## Command Usage\n\n```\nusage: irkit [-h] {local,internet} ...\n\nIRKit CLI Client for Python. v0.0.1 See also http://getirkit.com/#IRKit-\nDevice-API\n\npositional arguments:\n  {local,internet}  sub-command help\n    local           api for locals.\n    internet        api for internets.\n\noptional arguments:\n  -h, --help        show this help message and exit\n\n```\n\nLocal API:\n\n```\nusage: irkit local [-h] [--host] [-k] [-r] [--save signal-name] [-l]\n                   [-s signal-info] [-v]\n\noptional arguments:\n  -h, --help            show this help message and exit\n  --host                show irkit host\n  -k, --keys            get a client token.\n  -r, --retrieve        retrieve a signal\n  --save signal-name    you should appoint a name. save retrieved signal to\n                        ~/.config/irkit-py/signal.json with name\n  -l, --list            list of stored signals\n  -s signal-info, --send signal-info\n                        send a signal. that excepted as json response or\n                        raw_data or key name of store\n  -v, --verbose         put verbose logs\n```\n\nInternet API:\n\n```\nusage: irkit internet [-h] [-r] [-s signal-info] [--save signal-name]\n                      [-c CLIENT_KEY] [-d DEVICE_ID] [-v]\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -r, --retrieve        retrieve a signal\n  -s signal-info, --send signal-info\n                        send a signal. that excepted as json response or\n                        raw_data or key name of store\n  --save signal-name    you should appoint a name. save retrieved signal to\n                        ~/.config/irkit-py/signal.json with name\n  -c CLIENT_KEY, --client-key CLIENT_KEY\n                        client key\n  -d DEVICE_ID, --device-id DEVICE_ID\n                        device id\n  -v, --verbose         put verbose logs\n```\n\n\n### Example\n\ncopy and paste style\n\n```bash\n## you must send signal to IRKit before\n$ irkit local --retrieve\n{\"freq\": 38, \"data\": [... ...], \"format\": \"raw\"}\n\n## copy and paste the json\n$ irkit local --send '{\"freq\": 38, \"data\": [... ...], \"format\": \"raw\"}'\n```\n\nstore with key\n\n```bash\n$ irkit local --retrieve --save toggle-room-light\n{\"freq\": 38, \"data\": [... ...], \"format\": \"raw\"}\n\n$ cat ~/.config/irkit-py/signal.json\n{\"freq\": 38, \"data\": [... ...], \"format\": \"raw\"}\n\n$ irkit local --send movie-room-toggle\n```\n\n\n#### Internet API\n\nThen you want to send internet API, you need to appoint device_id or client_key or both.\n\n```bash\n## retrieve needs client key\n$ irkit internet --retrieve --client-key YOUR_CLIENT_KEY\n\n## send needs client key and device id\n$ irkit internet --send '{\"freq\": 38, \"data\": [... ...], \"format\": \"raw\"}' \\\n  -c 0A9B3FFB240444A2BA70A9835BFE4F89 \\\n  --device-id 6B08F5EA443E4983864908B4AFF897AA\n```\n\nThis tool haven't follow client-key and device-key smart integration (it can only get {*see --key option*}).\nIt'll be implemented next version (and I welcome to your contlibute!).\n\n\n## as Library\n\nYou can also use as api.\nDocument is now writing... but `main.py` will help you to understand API interfaces.\n\n\n## Support Versions\n\n- 2.7\n\n- 3.6 (might unstable)\n\n\n## Bug report or request or something\n\nGitHub issue is opend ;)\n\nhttps://github.com/hachibeeDI/IRKit/issues\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhachibeedi%2Firkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhachibeedi%2Firkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhachibeedi%2Firkit/lists"}