{"action":"created","comment":{"url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/comments/211337779","pull_request_review_id":147735877,"id":211337779,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIxMTMzNzc3OQ==","diff_hunk":"@@ -0,0 +1,192 @@\n+## Command-line test framework\n+\n+*Icetea* is an Arm Mbed test framework written with Python 2.7. You can use it to verify the Arm Mbed IoT Device Platform, which provides the operating system and cloud services.\n+\n+When testing Mbed OS, *Icetea* allows you to execute commands remotely using the command-line interface in the Device Under Test (`DUT`). The `DUT` runs an Mbed application that can connect to the test framework. The test framework itself runs on your computer. The interface between the test framework and `DUT` can be, for example, UART, a network socket or stdio. Icetea-related applications provided within Mbed OS use buffered stdio as the interface between the test framework and the `DUT`.\n+\n+### Installation\n+\n+We recommend creating a separate Python virtual environment for this purpose. To be able to run the test cases written with the Icetea test environment, you need to install Icetea in the system.\n+\n+#### Required dependencies:\n+\n+- To use **local Mbed devices**\n+  - [mbed-ls](https://github.com/armmbed/mbed-ls).\n+    - To enumerate connected boards.\n+  - [mbed-flasher](https://github.com/ARMmbed/mbed-flasher).\n+    - To flash devices automatically.\n+  - Icetea installation installs both of these automatically.\n+  \n+**OS specific:**\n+\n+Linux:\n+\n+- `python-dev` and `python-lxml`\n+`sudo apt-get install python-dev python-lxml`\n+- For documentation, install sphinx:\n+`apt-get install python-sphinx`\n+\n+OS X:\n+\n+- [XCode developer tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/).\n+- [lxml](http://lxml.de/installation.html#installation):\n+`STATIC_DEPS=true sudo pip install lxml`\n+- For documentation, install sphinx:\n+`sudo port install py27-sphinx`, `sudo port select --set python python27`, `sudo port select --set sphinx py27-sphinx`\n+\n+Windows:\n+\n+- `python-lxml` installation usually requires build tools. You can, however, install it from prebuilt binaries.\n+    - Download the binary for your system from the internet.\n+    - Navigate to the directory where you downloaded the binary, and install it with `pip install <insert_file_name>`.\n+- For documentation, install sphinx with pip:\n+`pip install sphinx`\n+\n+#### Optional dependencies\n+\n+- To decorate your console log with colors, install the coloredlogs module using pip:\n+`pip install coloredlogs`\n+    - Windows does not support the coloredlogs module.\n+- [valgrind](http://valgrind.org).\n+- [gdb](https://www.gnu.org/software/gdb/).\n+\n+#### Installation instructions\n+\n+```\n+git clone https://github.com/ARMmbed/icetea.git\n+cd icetea\n+python setup.py install\n+```\n+\n+**Linux**\n+\n+To run test cases with hardware in Linux without sudo rights:\n+\n+```\n+sudo usermod -a -G dialout username\n+Log out & log in back to Linux\n+```\n+\n+This command adds the user `username` to the `dialout` group and grants the required permissions to the USB ports.\n+\n+### Use\n+\n+To print the help page:\n+\n+`icetea --help`\n+\n+All CLI parameters are described in [icetea.md](https://github.com/ARMmbed/icetea/blob/master/doc/Icetea.md)","path":"docs/tools/testing/icetea.md","position":78,"original_position":78,"commit_id":"ba55a36368600b291386950a34f64fc7fe8028ec","original_commit_id":"ba55a36368600b291386950a34f64fc7fe8028ec","user":{"login":"AnotherButler","id":23487484,"node_id":"MDQ6VXNlcjIzNDg3NDg0","avatar_url":"https://avatars3.githubusercontent.com/u/23487484?v=4","gravatar_id":"","url":"https://api.github.com/users/AnotherButler","html_url":"https://github.com/AnotherButler","followers_url":"https://api.github.com/users/AnotherButler/followers","following_url":"https://api.github.com/users/AnotherButler/following{/other_user}","gists_url":"https://api.github.com/users/AnotherButler/gists{/gist_id}","starred_url":"https://api.github.com/users/AnotherButler/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AnotherButler/subscriptions","organizations_url":"https://api.github.com/users/AnotherButler/orgs","repos_url":"https://api.github.com/users/AnotherButler/repos","events_url":"https://api.github.com/users/AnotherButler/events{/privacy}","received_events_url":"https://api.github.com/users/AnotherButler/received_events","type":"User","site_admin":false},"body":"We don't like to link to GH. Is there somewhere in the documentation we can link, instead?","created_at":"2018-08-20T17:08:24Z","updated_at":"2018-08-20T17:09:01Z","html_url":"https://github.com/ARMmbed/mbed-os-5-docs/pull/659#discussion_r211337779","pull_request_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/659","author_association":"COLLABORATOR","_links":{"self":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/comments/211337779"},"html":{"href":"https://github.com/ARMmbed/mbed-os-5-docs/pull/659#discussion_r211337779"},"pull_request":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/659"}}},"pull_request":{"url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/659","id":207911710,"node_id":"MDExOlB1bGxSZXF1ZXN0MjA3OTExNzEw","html_url":"https://github.com/ARMmbed/mbed-os-5-docs/pull/659","diff_url":"https://github.com/ARMmbed/mbed-os-5-docs/pull/659.diff","patch_url":"https://github.com/ARMmbed/mbed-os-5-docs/pull/659.patch","issue_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/issues/659","number":659,"state":"open","locked":false,"title":"Icetea added","user":{"login":"OPpuolitaival","id":765408,"node_id":"MDQ6VXNlcjc2NTQwOA==","avatar_url":"https://avatars2.githubusercontent.com/u/765408?v=4","gravatar_id":"","url":"https://api.github.com/users/OPpuolitaival","html_url":"https://github.com/OPpuolitaival","followers_url":"https://api.github.com/users/OPpuolitaival/followers","following_url":"https://api.github.com/users/OPpuolitaival/following{/other_user}","gists_url":"https://api.github.com/users/OPpuolitaival/gists{/gist_id}","starred_url":"https://api.github.com/users/OPpuolitaival/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/OPpuolitaival/subscriptions","organizations_url":"https://api.github.com/users/OPpuolitaival/orgs","repos_url":"https://api.github.com/users/OPpuolitaival/repos","events_url":"https://api.github.com/users/OPpuolitaival/events{/privacy}","received_events_url":"https://api.github.com/users/OPpuolitaival/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-08-13T09:02:10Z","updated_at":"2018-08-20T17:09:01Z","closed_at":null,"merged_at":null,"merge_commit_sha":"65a5abee39db6ca3e5d6d30963b448e43f9207dc","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/659/commits","review_comments_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/659/comments","review_comment_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/issues/659/comments","statuses_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/statuses/ba55a36368600b291386950a34f64fc7fe8028ec","head":{"label":"OPpuolitaival:icetea","ref":"icetea","sha":"ba55a36368600b291386950a34f64fc7fe8028ec","user":{"login":"OPpuolitaival","id":765408,"node_id":"MDQ6VXNlcjc2NTQwOA==","avatar_url":"https://avatars2.githubusercontent.com/u/765408?v=4","gravatar_id":"","url":"https://api.github.com/users/OPpuolitaival","html_url":"https://github.com/OPpuolitaival","followers_url":"https://api.github.com/users/OPpuolitaival/followers","following_url":"https://api.github.com/users/OPpuolitaival/following{/other_user}","gists_url":"https://api.github.com/users/OPpuolitaival/gists{/gist_id}","starred_url":"https://api.github.com/users/OPpuolitaival/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/OPpuolitaival/subscriptions","organizations_url":"https://api.github.com/users/OPpuolitaival/orgs","repos_url":"https://api.github.com/users/OPpuolitaival/repos","events_url":"https://api.github.com/users/OPpuolitaival/events{/privacy}","received_events_url":"https://api.github.com/users/OPpuolitaival/received_events","type":"User","site_admin":false},"repo":{"id":144553079,"node_id":"MDEwOlJlcG9zaXRvcnkxNDQ1NTMwNzk=","name":"mbed-os-5-docs","full_name":"OPpuolitaival/mbed-os-5-docs","owner":{"login":"OPpuolitaival","id":765408,"node_id":"MDQ6VXNlcjc2NTQwOA==","avatar_url":"https://avatars2.githubusercontent.com/u/765408?v=4","gravatar_id":"","url":"https://api.github.com/users/OPpuolitaival","html_url":"https://github.com/OPpuolitaival","followers_url":"https://api.github.com/users/OPpuolitaival/followers","following_url":"https://api.github.com/users/OPpuolitaival/following{/other_user}","gists_url":"https://api.github.com/users/OPpuolitaival/gists{/gist_id}","starred_url":"https://api.github.com/users/OPpuolitaival/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/OPpuolitaival/subscriptions","organizations_url":"https://api.github.com/users/OPpuolitaival/orgs","repos_url":"https://api.github.com/users/OPpuolitaival/repos","events_url":"https://api.github.com/users/OPpuolitaival/events{/privacy}","received_events_url":"https://api.github.com/users/OPpuolitaival/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/OPpuolitaival/mbed-os-5-docs","description":"New version of the handbook for Mbed OS","fork":true,"url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs","forks_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/forks","keys_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/teams","hooks_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/hooks","issue_events_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/issues/events{/number}","events_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/events","assignees_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/assignees{/user}","branches_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/branches{/branch}","tags_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/tags","blobs_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/languages","stargazers_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/stargazers","contributors_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/contributors","subscribers_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/subscribers","subscription_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/subscription","commits_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/contents/{+path}","compare_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/merges","archive_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/downloads","issues_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/issues{/number}","pulls_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/labels{/name}","releases_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/releases{/id}","deployments_url":"https://api.github.com/repos/OPpuolitaival/mbed-os-5-docs/deployments","created_at":"2018-08-13T08:47:55Z","updated_at":"2018-08-13T08:47:58Z","pushed_at":"2018-08-20T17:02:55Z","git_url":"git://github.com/OPpuolitaival/mbed-os-5-docs.git","ssh_url":"git@github.com:OPpuolitaival/mbed-os-5-docs.git","clone_url":"https://github.com/OPpuolitaival/mbed-os-5-docs.git","svn_url":"https://github.com/OPpuolitaival/mbed-os-5-docs","homepage":"","size":30518,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":null,"forks":0,"open_issues":0,"watchers":0,"default_branch":"development"}},"base":{"label":"ARMmbed:development","ref":"development","sha":"99391011c8a621137d98f81e22cd3dab40529bfa","user":{"login":"ARMmbed","id":8916057,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg5MTYwNTc=","avatar_url":"https://avatars3.githubusercontent.com/u/8916057?v=4","gravatar_id":"","url":"https://api.github.com/users/ARMmbed","html_url":"https://github.com/ARMmbed","followers_url":"https://api.github.com/users/ARMmbed/followers","following_url":"https://api.github.com/users/ARMmbed/following{/other_user}","gists_url":"https://api.github.com/users/ARMmbed/gists{/gist_id}","starred_url":"https://api.github.com/users/ARMmbed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ARMmbed/subscriptions","organizations_url":"https://api.github.com/users/ARMmbed/orgs","repos_url":"https://api.github.com/users/ARMmbed/repos","events_url":"https://api.github.com/users/ARMmbed/events{/privacy}","received_events_url":"https://api.github.com/users/ARMmbed/received_events","type":"Organization","site_admin":false},"repo":{"id":31957877,"node_id":"MDEwOlJlcG9zaXRvcnkzMTk1Nzg3Nw==","name":"mbed-os-5-docs","full_name":"ARMmbed/mbed-os-5-docs","owner":{"login":"ARMmbed","id":8916057,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg5MTYwNTc=","avatar_url":"https://avatars3.githubusercontent.com/u/8916057?v=4","gravatar_id":"","url":"https://api.github.com/users/ARMmbed","html_url":"https://github.com/ARMmbed","followers_url":"https://api.github.com/users/ARMmbed/followers","following_url":"https://api.github.com/users/ARMmbed/following{/other_user}","gists_url":"https://api.github.com/users/ARMmbed/gists{/gist_id}","starred_url":"https://api.github.com/users/ARMmbed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ARMmbed/subscriptions","organizations_url":"https://api.github.com/users/ARMmbed/orgs","repos_url":"https://api.github.com/users/ARMmbed/repos","events_url":"https://api.github.com/users/ARMmbed/events{/privacy}","received_events_url":"https://api.github.com/users/ARMmbed/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ARMmbed/mbed-os-5-docs","description":"New version of the handbook for Mbed OS","fork":false,"url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs","forks_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/forks","keys_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/teams","hooks_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/hooks","issue_events_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/issues/events{/number}","events_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/events","assignees_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/assignees{/user}","branches_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/branches{/branch}","tags_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/tags","blobs_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/languages","stargazers_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/stargazers","contributors_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/contributors","subscribers_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/subscribers","subscription_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/subscription","commits_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/contents/{+path}","compare_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/merges","archive_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/downloads","issues_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/issues{/number}","pulls_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/labels{/name}","releases_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/releases{/id}","deployments_url":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/deployments","created_at":"2015-03-10T13:06:41Z","updated_at":"2018-08-20T16:43:13Z","pushed_at":"2018-08-20T17:02:56Z","git_url":"git://github.com/ARMmbed/mbed-os-5-docs.git","ssh_url":"git@github.com:ARMmbed/mbed-os-5-docs.git","clone_url":"https://github.com/ARMmbed/mbed-os-5-docs.git","svn_url":"https://github.com/ARMmbed/mbed-os-5-docs","homepage":"","size":30699,"stargazers_count":31,"watchers_count":31,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":98,"mirror_url":null,"archived":false,"open_issues_count":44,"license":null,"forks":98,"open_issues":44,"watchers":31,"default_branch":"development"}},"_links":{"self":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/659"},"html":{"href":"https://github.com/ARMmbed/mbed-os-5-docs/pull/659"},"issue":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/issues/659"},"comments":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/issues/659/comments"},"review_comments":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/659/comments"},"review_comment":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/pulls/659/commits"},"statuses":{"href":"https://api.github.com/repos/ARMmbed/mbed-os-5-docs/statuses/ba55a36368600b291386950a34f64fc7fe8028ec"}},"author_association":"NONE"}}
{"actor":{"display_login":"AnotherButler"}}