{"id":19362718,"url":"https://github.com/smartdevicelink/relay_app_ios","last_synced_at":"2025-07-04T04:34:24.607Z","repository":{"id":146486243,"uuid":"53163363","full_name":"smartdevicelink/relay_app_ios","owner":"smartdevicelink","description":null,"archived":false,"fork":false,"pushed_at":"2018-07-05T21:48:15.000Z","size":311,"stargazers_count":12,"open_issues_count":4,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-23T12:52:30.562Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smartdevicelink.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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}},"created_at":"2016-03-04T20:26:27.000Z","updated_at":"2025-01-17T15:06:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"a9a3a1fc-c2fd-4f04-8581-7a97043286a5","html_url":"https://github.com/smartdevicelink/relay_app_ios","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/smartdevicelink/relay_app_ios","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Frelay_app_ios","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Frelay_app_ios/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Frelay_app_ios/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Frelay_app_ios/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartdevicelink","download_url":"https://codeload.github.com/smartdevicelink/relay_app_ios/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartdevicelink%2Frelay_app_ios/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263447101,"owners_count":23467892,"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":[],"created_at":"2024-11-10T07:30:02.864Z","updated_at":"2025-07-04T04:34:24.598Z","avatar_url":"https://github.com/smartdevicelink.png","language":"Objective-C","funding_links":[],"categories":[],"sub_categories":[],"readme":"![logo](https://github.com/smartdevicelink/relay_app_ios/blob/master/Readme%20Files/AppIcon.png)\n# SmartDeviceLink (SDL) iOS Relay\n\nSDL iOS Relay is a tool built for developers building applications\nthat utilizes SmartDeviceLink for connecting their apps to technologies using\nour [SmartDeviceLink Core](https://github.com/smartdevicelink/sdl_core) connected\nvia USB. This tool allows those developers to test their applications over a TCP/IP connection, allowing developers to easily see debug logs to make development faster\nand easier.\n\n### Things To Note\n- Make sure that both SDL iOS Relay and your app are connected to the\n**same** wifi network.\n\n\n## Relay Status\n\n#### Start\n\u003cimg src=\"/Readme Files/Start.png\" width=\"200px\"\u003e\n\u003e Initial app startup. This state is visible when the app is not connected to\nhardware running SDL Core via USB.\n\n#### USB Connected\n\u003cimg src=\"/Readme Files/USBConnected.png\" width=\"200px\"\u003e\n\u003e When Relay is initially connected via USB, but the connection isn't complete.\n\n#### EASession Connected\n\u003cimg src=\"/Readme Files/EASessionConnected.png\" width=\"200px\"\u003e\n\u003e When the Relay is fully connected via USB, and ready for server start.\n\n#### Relay started\n\u003cimg src=\"/Readme Files/ServerStarted.png\" width=\"200px\"\u003e\n\u003e Server is now started, and awating connection.\n\n\n#### Connected to Relay\n\u003cimg src=\"/Readme Files/TCPConnected.png\" width=\"200px\"\u003e\n\u003e Application is correctly connected to Relay, and messages can\nnow be sent and received.\n\n## How To Start Testing Using Relay\n\n\u003e ###### For all documentation purposes, we will be using our [SDL iOS Library](https://github.com/smartdevicelink/sdl_ios) for code snippets.\n\nTo get started, please be sure to use the proxy builder's [TCP/IP initializer](https://github.com/smartdevicelink/sdl_ios/blob/master/SmartDeviceLink-iOS/SmartDeviceLink/SDLProxyFactory.h#L16).\n```objective-c\nSDLProxy* proxy = [SDLProxyFactory buildSDLProxyWithListener:sdlProxyListenerDelegate\n                                                tcpIPAddress:@\"1.2.3.4\"\n                                                        port:@\"2776\"];\n```\n\u003e NOTE: Be sure to start the Relay app **before** connecting your application to it.\n\n## Need Help?\nIf you need general assistance, or have other questions, you can [sign up](http://slack.smartdevicelink.org/) for the [SDL Slack](https://smartdevicelink.slack.com/) and chat with other developers and the maintainers of the project.\n\n## Found a Bug?\nIf you see a bug, feel free to [post an issue](https://github.com/smartdevicelink/relay_app_ios/issues/new). Please see the [contribution guidelines](https://github.com/smartdevicelink/relay_app_ios/blob/master/CONTRIBUTING.md) before proceeding.\n\n## Want to Help?\nIf you want to help add more features, please [file a pull request](https://github.com/smartdevicelink/relay_app_ios/compare). Please see the [contribution guidelines](https://github.com/smartdevicelink/relay_app_ios/blob/master/CONTRIBUTING.md) before proceeding.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartdevicelink%2Frelay_app_ios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartdevicelink%2Frelay_app_ios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartdevicelink%2Frelay_app_ios/lists"}