{"id":16171400,"url":"https://github.com/igormukhingmailcom/ajax-systems-api","last_synced_at":"2025-03-19T00:30:39.555Z","repository":{"id":41211685,"uuid":"149126525","full_name":"igormukhingmailcom/ajax-systems-api","owner":"igormukhingmailcom","description":"PHP library to work with Ajax Systems API","archived":false,"fork":false,"pushed_at":"2019-03-25T16:04:29.000Z","size":17,"stargazers_count":55,"open_issues_count":0,"forks_count":3,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-28T13:18:33.128Z","etag":null,"topics":["ajaxsystems","api","php","php7","sdk"],"latest_commit_sha":null,"homepage":"https://ajax.systems","language":"PHP","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/igormukhingmailcom.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}},"created_at":"2018-09-17T13:06:29.000Z","updated_at":"2024-12-29T07:06:16.000Z","dependencies_parsed_at":"2022-08-21T12:50:32.111Z","dependency_job_id":null,"html_url":"https://github.com/igormukhingmailcom/ajax-systems-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igormukhingmailcom%2Fajax-systems-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igormukhingmailcom%2Fajax-systems-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igormukhingmailcom%2Fajax-systems-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igormukhingmailcom%2Fajax-systems-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/igormukhingmailcom","download_url":"https://codeload.github.com/igormukhingmailcom/ajax-systems-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243955755,"owners_count":20374373,"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":["ajaxsystems","api","php","php7","sdk"],"created_at":"2024-10-10T03:23:42.028Z","updated_at":"2025-03-19T00:30:39.169Z","avatar_url":"https://github.com/igormukhingmailcom.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AjaxSystemsApi\n\n[![Latest Version on Packagist][ico-version]][link-packagist]\n[![Software License][ico-license]](LICENSE)\n[![Quality Score][ico-code-quality]][link-code-quality]\n\nAPI client for [ajax.systems](https://ajax.systems/) security system\n\n**Warning** \nThis library is based on grey/reverse engineered Ajax Systems **Web API** which was closed at 2018.\nSo currently this library doesn't work.\n\n**Future upgrade**\nNew non-public **Ajax Systems Enterprise API** is under development right now.\nPlease, star this project if you interested to be announced once \n**Enterprise API** become public and available to all clients.\n\n## Cases current library covers\n\n(Sublists contain cases when library potentially can be used) \n\n- [x] [Turn on/off WallSwitches](examples/wallswitch)\n  - Turn on/off lights/boiler/irrigation connected to WallSwitch with CRON\n  - Ignite a TNT connected to WallSwitch on some external event\n- [x] [Arm/disarm/partially arm (night mode)](examples/arm)\n  - Arm/disarm your Hub with CRON\n- [x] [Send panic](examples/panic)\n  - Send panic to Hub on some external event\n- [x] [Get Hub's raw data](examples/hubs)\n  - Get battery charge of all sensors daily and send notification to user's email with CRON \n  - Get temperature of some room's sensor to turn on room's heater\n  - Get power consumption of WallSwitch connected device to store statistics\n  - Self-test script to check important sensors settings and send notification to user's \n    email if some important settings was changed since last time \n- [x] [Read raw log](examples/logs)\n  - Track HUB events for home automation\n  - Backup events to external source\n- [x] [Get Hub's SIM card balance](examples/balance)\n  - Track and warn user if balance is low\n  - Track and automatically add money to balance (pay via some service) \n    if balance is low\n- [x] [Get logged in user data](examples/user)\n\n## Installation\n\n```bash\ncomposer require igormukhingmailcom/ajax-systems-api\n```\n\n## Usage\n\n```php\n\u003c?php\n\nrequire('vendor/autoload.php');\n\nuse Mukhin\\AjaxSystemsApi\\AjaxSystemsApiClient;\nuse Mukhin\\AjaxSystemsApi\\Exception\\Exception;\n\n$ajaxSystemsClient = new AjaxSystemsApiClient();\n\ntry {\n    $ajaxSystemsClient-\u003elogin('login', 'password');\n    $ajaxSystemsClient-\u003egetCsaConnection();\n    $ajaxSystemsClient-\u003esetArm(AjaxSystemsApiClient::ARM_STATE_PARTIAL, 'hub id');\n    echo \"Partially armed\";\n} catch (Exception $e) {\n    echo $e-\u003egetMessage();\n}\n```\n\n# Contribution\n\n## Testing / running examples\n\n```bash\ncomposer install\n\n# Put your credentials to credentials.php\ncp examples/credentials.php.dist examples/credentials.php\nnano examples/credentials.php\n\n# Go to any example an run it\ncd examples/arm\nphp index.php\n```\n\n# TODO\n\n- [ ] Turn on/off Ajax Relay if this supported by app.ajax.systems (haven't this device to play with)\n- [ ] Turn on/off Ajax Socket if this supported by app.ajax.systems (haven't this device to play with)\n- [ ] Convert RAW data to objects\n- [ ] Save objects\n- [ ] SSE (server-sent events)\n- [ ] Symfony bundle\n\n\n[ico-version]: https://img.shields.io/packagist/v/igormukhingmailcom/ajax-systems-api.svg?style=flat-square\n[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\n[ico-code-quality]: https://img.shields.io/scrutinizer/g/igormukhingmailcom/ajax-systems-api.svg?style=flat-square\n\n[link-packagist]: https://packagist.org/packages/igormukhingmailcom/ajax-systems-api\n[link-code-quality]: https://scrutinizer-ci.com/g/igormukhingmailcom/ajax-systems-apiAJAX_DEFAULT_HUB_ID\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figormukhingmailcom%2Fajax-systems-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figormukhingmailcom%2Fajax-systems-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figormukhingmailcom%2Fajax-systems-api/lists"}