{"id":18078392,"url":"https://github.com/techgaun/telix","last_synced_at":"2025-04-05T20:40:46.877Z","repository":{"id":62430368,"uuid":"106470064","full_name":"techgaun/telix","owner":"techgaun","description":"Telit TR50 M2M Service Interface API Client For Elixir","archived":false,"fork":false,"pushed_at":"2018-07-12T05:32:25.000Z","size":26,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T06:05:49.951Z","etag":null,"topics":["elixir","sdk","telit"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/techgaun.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}},"created_at":"2017-10-10T20:52:42.000Z","updated_at":"2018-07-12T05:32:26.000Z","dependencies_parsed_at":"2022-11-01T20:19:51.564Z","dependency_job_id":null,"html_url":"https://github.com/techgaun/telix","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techgaun%2Ftelix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techgaun%2Ftelix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techgaun%2Ftelix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/techgaun%2Ftelix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/techgaun","download_url":"https://codeload.github.com/techgaun/telix/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399898,"owners_count":20932876,"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":["elixir","sdk","telit"],"created_at":"2024-10-31T12:13:52.163Z","updated_at":"2025-04-05T20:40:46.860Z","avatar_url":"https://github.com/techgaun.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Telix\n\n[![Hex version](https://img.shields.io/hexpm/v/telix.svg \"Hex version\")](https://hex.pm/packages/telix) ![Hex downloads](https://img.shields.io/hexpm/dt/telix.svg \"Hex downloads\")\n\n\u003e Telit TR50 M2M Service Interface API Client For Elixir\n\n## Introduction\n\nTelix is an API client that talks with [M2M Service Interface API](http://help.devicewise.com/display/ARG/M2M+Service+Interface?src=contextnavpagetreemode)\nof Telit M2M Service using [TR50 Message Format](http://help.devicewise.com/display/ARG/TR50+Message+Format?src=contextnavpagetreemode)\n\n## Installation\n\nAdd the following line in your `mix.exs`:\n\n```elixir\ndefp deps do\n  [\n    {:telix, \"~\u003e 0.1\"}\n  ]\nend\n```\n\n## Configuration\n\nBoth username/password and app token based authentications are supported.\nYou can pass authentication related parameters while creating Telit Client.\nYou can also choose to create client by specifying appropriate configuration as below\n\nWith [application authentication](http://help.devicewise.com/display/ARG/HTTP+Interface#HTTPInterface-HTTPAuthentication):\n\n```elixir\nconfig :telix,\n  auth: %{\n    thingKey: \"some-thing-key\",\n    appId: \"telit-app-id\",\n    appToken: System.get_env(\"TELIT_TOKEN\")\n  }\n```\n\nWith [user authentication](http://help.devicewise.com/display/ARG/HTTP+Interface#HTTPInterface-HTTPAuthentication)\n\n```elixir\nconfig :telix,\n  auth: %{\n    username: \"some-telit-user\",\n    password: System.get_env(\"TELIT_PASSWORD\")\n  }\n```\n\nCurrently, the user authentication does not support MFA.\n\n## Usage\n\nAll the API calls are made by creating new [Telit Client](lib/telix/client.ex).\n\n```elixir\n:config\nTelix.Client.new\n|\u003e Telix.Client.login\n|\u003e Telix.CDP.Connection.health_summary\n```\n\n```elixir\n%{\n  username: \"some-telit-user\",\n  password: \"some-password\"\n}\n|\u003e Telix.Client.new\n|\u003e Telix.Client.login\n|\u003e Telix.CDP.Connection.health_summary\n```\n\nWhile this library provides convenience modules to call certain commands,\nyou can also manually perform any sort of commands. This is esp. useful\nfor sending [multiple commands](http://help.devicewise.com/display/ARG/TR50+Message+Format)\n\n```elixir\nclient = :config |\u003e Telix.Client.new |\u003e Telix.Client.login\n\n# single command with custom params\nTelix.Api.do_post build_payload(\"some.custom.command\", %{\"some\" =\u003e \"params\"}), client\n\n# custom command params\nmulti_cmd = %{\n  \"1\" =\u003e %{\n    \"command\" =\u003e \"some.custom.command\",\n    \"params\" =\u003e %{\"some\" =\u003e \"params\"}\n  },\n  \"2\" =\u003e %{\n    \"command\" =\u003e \"another.custom.command\",\n    \"params\" =\u003e %{\"some\" =\u003e \"params\"}\n  }\n}\nTelix.Api.do_post multi_cmd, client\n```\n\n## Author\n\n- [techgaun](https://github.com/techgaun)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechgaun%2Ftelix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechgaun%2Ftelix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechgaun%2Ftelix/lists"}