{"action":"created","comment":{"url":"https://api.github.com/repos/jonnew/cyclops/pulls/comments/67596088","id":67596088,"diff_hunk":"@@ -1,13 +1,80 @@\n /** @file RPC_defs.h\n     @brief Defines a few constants of the RPC Format Specification.\n            This file is part of CL.\n-  \n-    @section header-desc HEADER Field Description\n-    ~~~~~~~~~~~~~~~~~~~~\n-        <2: channel> <6: command>\n-        [7:6] Channel\n-        [5:0] Command\n-    ~~~~~~~~~~~~~~~~~~~~\n+    \n+    @page rpc-desc RPC Format Description\n+\n+    @tableofcontents\n+\n+    @section rpc-overview Overview\n+    There are two kinds of Serial packets, single byte and multi byte.\n+    The size of a packet is determined by MSB of header and the ``command`` field.\n+\n+    @section S-header-desc Single Byte Packets\n+    Single byte Headers are distinguished from other headers by the MSB bit. For\n+    Single byte headers, this bit is always set\n+    \n+    Field       | Bits  | Description\n+    ----------- | ----- | -----------\n+    Reserved    | [7]   | Always ``1``.\n+    ``channel`` | [6:3] | Determines if \"command\" is applied on the Channel @par 1: Command is appplied on Channel\n+    ``command`` | [2:0] | The command field\n+    \n+    @subsection S-cmd-desc Command descriptions\n+    \n+    command[3:0] | Name     | Effect\n+    ------------ | -------  | -------------\n+    ``0000``     | start    | Launch mainloop\n+    ``0001``     | stop     | Pause mainloop\n+    ``0010``     | reset    | Reset all sources. @attention The system is *not* reset to _initial configuration_!\n+    ``0011``     | swap     | Swap the Cyclops instances of the 2 high ``channel`` bits.\n+    ``1111``     | identity | Send device description\n+    \n+    @section M-header-desc Multi Byte Packets\n+    Packet is formed by concatenating the header with argument bytes.\n+\n+    Field       | Bits  | Description\n+    ----------- | ----- | -----------\n+    Reserved    | [7]   | Always ``0``.\n+    ``channel`` | [6:5] | Command is appplied on Channel ``channel[1:0]``\n+    ``command`` | [4:0] | The command field\n+\n+    @subsection M-cmd-desc Command descriptions\n+\n+    command[4:0]  | Name               | Size(Bytes) | Effect\n+    ------------- | ------------------ | ----------- | --------\n+    ``00000``     | change_source_l    | 2           | Changes Source instance to the one reffered by @ref src-id-sec. Mode is set to ``LOOPBACK``.\n+    ``00001``     | change_source_o    | 2           | Changes Source instance to the one reffered by @ref src-id-sec. Mode is set to ``ONE_SHOT``.\n+    ``00010``     | change_source_n    | 3           | Changes Source instance to the one reffered by @ref src-id-sec. Mode is set to ``N_SHOT``. \\f$N\\f$ is set to @ref shot_cycle \"shot_cycle\"\n+    ``00011``     | change_time_period | 5           | Set time period of updates @attention Works only if Source::holdTime is a constant!\n+    ``00101``     | time_factor        | 5           | Scale Source::holdTime values by this factor. \\f$\\in (0, \\infty)\\f$.\n+    ``00111``     | voltage_offset     | 3           | Add this DC offset level to Source::getVoltage values. \\f$\\in (0, \\infty)\\f$.\n+    ``01000``     | square_on_time     | 5           | Set squareSource::onTime.\n+    ``01001``     | square_off_time    | 5           | Set squareSource::offTime.\n+\n+    @note       Unlike providing a scaling factor for time, we don't provide a","path":"lib/cyclops/RPC_defs.h","position":62,"original_position":62,"commit_id":"a7356fa1f4fbb4b023793ad0f7bc9956ad3c39ee","original_commit_id":"a7356fa1f4fbb4b023793ad0f7bc9956ad3c39ee","user":{"login":"arrow-","id":9897445,"avatar_url":"https://avatars.githubusercontent.com/u/9897445?v=3","gravatar_id":"","url":"https://api.github.com/users/arrow-","html_url":"https://github.com/arrow-","followers_url":"https://api.github.com/users/arrow-/followers","following_url":"https://api.github.com/users/arrow-/following{/other_user}","gists_url":"https://api.github.com/users/arrow-/gists{/gist_id}","starred_url":"https://api.github.com/users/arrow-/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arrow-/subscriptions","organizations_url":"https://api.github.com/users/arrow-/orgs","repos_url":"https://api.github.com/users/arrow-/repos","events_url":"https://api.github.com/users/arrow-/events{/privacy}","received_events_url":"https://api.github.com/users/arrow-/received_events","type":"User","site_admin":false},"body":"Right! will add that.","created_at":"2016-06-18T05:32:23Z","updated_at":"2016-06-18T05:32:23Z","html_url":"https://github.com/jonnew/cyclops/pull/11#discussion_r67596088","pull_request_url":"https://api.github.com/repos/jonnew/cyclops/pulls/11","_links":{"self":{"href":"https://api.github.com/repos/jonnew/cyclops/pulls/comments/67596088"},"html":{"href":"https://github.com/jonnew/cyclops/pull/11#discussion_r67596088"},"pull_request":{"href":"https://api.github.com/repos/jonnew/cyclops/pulls/11"}}},"pull_request":{"url":"https://api.github.com/repos/jonnew/cyclops/pulls/11","id":74252286,"html_url":"https://github.com/jonnew/cyclops/pull/11","diff_url":"https://github.com/jonnew/cyclops/pull/11.diff","patch_url":"https://github.com/jonnew/cyclops/pull/11.patch","issue_url":"https://api.github.com/repos/jonnew/cyclops/issues/11","number":11,"state":"open","locked":false,"title":"RPC discussion","user":{"login":"arrow-","id":9897445,"avatar_url":"https://avatars.githubusercontent.com/u/9897445?v=3","gravatar_id":"","url":"https://api.github.com/users/arrow-","html_url":"https://github.com/arrow-","followers_url":"https://api.github.com/users/arrow-/followers","following_url":"https://api.github.com/users/arrow-/following{/other_user}","gists_url":"https://api.github.com/users/arrow-/gists{/gist_id}","starred_url":"https://api.github.com/users/arrow-/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arrow-/subscriptions","organizations_url":"https://api.github.com/users/arrow-/orgs","repos_url":"https://api.github.com/users/arrow-/repos","events_url":"https://api.github.com/users/arrow-/events{/privacy}","received_events_url":"https://api.github.com/users/arrow-/received_events","type":"User","site_admin":false},"body":"Generate the docs and look for a page on RPC.\r\nI'm implementing this right now as a start but any additions/deletions welcome.","created_at":"2016-06-17T14:34:47Z","updated_at":"2016-06-18T05:32:23Z","closed_at":null,"merged_at":null,"merge_commit_sha":"d4cfebf454db71a3a158fc36600a9f0631519ade","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/jonnew/cyclops/pulls/11/commits","review_comments_url":"https://api.github.com/repos/jonnew/cyclops/pulls/11/comments","review_comment_url":"https://api.github.com/repos/jonnew/cyclops/pulls/comments{/number}","comments_url":"https://api.github.com/repos/jonnew/cyclops/issues/11/comments","statuses_url":"https://api.github.com/repos/jonnew/cyclops/statuses/a7356fa1f4fbb4b023793ad0f7bc9956ad3c39ee","head":{"label":"arrow-:gsoc-dev","ref":"gsoc-dev","sha":"a7356fa1f4fbb4b023793ad0f7bc9956ad3c39ee","user":{"login":"arrow-","id":9897445,"avatar_url":"https://avatars.githubusercontent.com/u/9897445?v=3","gravatar_id":"","url":"https://api.github.com/users/arrow-","html_url":"https://github.com/arrow-","followers_url":"https://api.github.com/users/arrow-/followers","following_url":"https://api.github.com/users/arrow-/following{/other_user}","gists_url":"https://api.github.com/users/arrow-/gists{/gist_id}","starred_url":"https://api.github.com/users/arrow-/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arrow-/subscriptions","organizations_url":"https://api.github.com/users/arrow-/orgs","repos_url":"https://api.github.com/users/arrow-/repos","events_url":"https://api.github.com/users/arrow-/events{/privacy}","received_events_url":"https://api.github.com/users/arrow-/received_events","type":"User","site_admin":false},"repo":{"id":54724453,"name":"cyclops","full_name":"arrow-/cyclops","owner":{"login":"arrow-","id":9897445,"avatar_url":"https://avatars.githubusercontent.com/u/9897445?v=3","gravatar_id":"","url":"https://api.github.com/users/arrow-","html_url":"https://github.com/arrow-","followers_url":"https://api.github.com/users/arrow-/followers","following_url":"https://api.github.com/users/arrow-/following{/other_user}","gists_url":"https://api.github.com/users/arrow-/gists{/gist_id}","starred_url":"https://api.github.com/users/arrow-/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/arrow-/subscriptions","organizations_url":"https://api.github.com/users/arrow-/orgs","repos_url":"https://api.github.com/users/arrow-/repos","events_url":"https://api.github.com/users/arrow-/events{/privacy}","received_events_url":"https://api.github.com/users/arrow-/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/arrow-/cyclops","description":"Precision current source, with optional optical feedback, for driving high power LEDs","fork":true,"url":"https://api.github.com/repos/arrow-/cyclops","forks_url":"https://api.github.com/repos/arrow-/cyclops/forks","keys_url":"https://api.github.com/repos/arrow-/cyclops/keys{/key_id}","collaborators_url":"https://api.github.com/repos/arrow-/cyclops/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/arrow-/cyclops/teams","hooks_url":"https://api.github.com/repos/arrow-/cyclops/hooks","issue_events_url":"https://api.github.com/repos/arrow-/cyclops/issues/events{/number}","events_url":"https://api.github.com/repos/arrow-/cyclops/events","assignees_url":"https://api.github.com/repos/arrow-/cyclops/assignees{/user}","branches_url":"https://api.github.com/repos/arrow-/cyclops/branches{/branch}","tags_url":"https://api.github.com/repos/arrow-/cyclops/tags","blobs_url":"https://api.github.com/repos/arrow-/cyclops/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/arrow-/cyclops/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/arrow-/cyclops/git/refs{/sha}","trees_url":"https://api.github.com/repos/arrow-/cyclops/git/trees{/sha}","statuses_url":"https://api.github.com/repos/arrow-/cyclops/statuses/{sha}","languages_url":"https://api.github.com/repos/arrow-/cyclops/languages","stargazers_url":"https://api.github.com/repos/arrow-/cyclops/stargazers","contributors_url":"https://api.github.com/repos/arrow-/cyclops/contributors","subscribers_url":"https://api.github.com/repos/arrow-/cyclops/subscribers","subscription_url":"https://api.github.com/repos/arrow-/cyclops/subscription","commits_url":"https://api.github.com/repos/arrow-/cyclops/commits{/sha}","git_commits_url":"https://api.github.com/repos/arrow-/cyclops/git/commits{/sha}","comments_url":"https://api.github.com/repos/arrow-/cyclops/comments{/number}","issue_comment_url":"https://api.github.com/repos/arrow-/cyclops/issues/comments{/number}","contents_url":"https://api.github.com/repos/arrow-/cyclops/contents/{+path}","compare_url":"https://api.github.com/repos/arrow-/cyclops/compare/{base}...{head}","merges_url":"https://api.github.com/repos/arrow-/cyclops/merges","archive_url":"https://api.github.com/repos/arrow-/cyclops/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/arrow-/cyclops/downloads","issues_url":"https://api.github.com/repos/arrow-/cyclops/issues{/number}","pulls_url":"https://api.github.com/repos/arrow-/cyclops/pulls{/number}","milestones_url":"https://api.github.com/repos/arrow-/cyclops/milestones{/number}","notifications_url":"https://api.github.com/repos/arrow-/cyclops/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/arrow-/cyclops/labels{/name}","releases_url":"https://api.github.com/repos/arrow-/cyclops/releases{/id}","deployments_url":"https://api.github.com/repos/arrow-/cyclops/deployments","created_at":"2016-03-25T14:37:40Z","updated_at":"2016-04-21T16:15:42Z","pushed_at":"2016-06-17T14:32:31Z","git_url":"git://github.com/arrow-/cyclops.git","ssh_url":"git@github.com:arrow-/cyclops.git","clone_url":"https://github.com/arrow-/cyclops.git","svn_url":"https://github.com/arrow-/cyclops","homepage":null,"size":350350,"stargazers_count":1,"watchers_count":1,"language":"Eagle","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":1,"default_branch":"master"}},"base":{"label":"jonnew:gsoc-dev","ref":"gsoc-dev","sha":"03e7076c5e2940bc16df22357fb744171927eea2","user":{"login":"jonnew","id":1429475,"avatar_url":"https://avatars.githubusercontent.com/u/1429475?v=3","gravatar_id":"","url":"https://api.github.com/users/jonnew","html_url":"https://github.com/jonnew","followers_url":"https://api.github.com/users/jonnew/followers","following_url":"https://api.github.com/users/jonnew/following{/other_user}","gists_url":"https://api.github.com/users/jonnew/gists{/gist_id}","starred_url":"https://api.github.com/users/jonnew/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jonnew/subscriptions","organizations_url":"https://api.github.com/users/jonnew/orgs","repos_url":"https://api.github.com/users/jonnew/repos","events_url":"https://api.github.com/users/jonnew/events{/privacy}","received_events_url":"https://api.github.com/users/jonnew/received_events","type":"User","site_admin":false},"repo":{"id":8987916,"name":"cyclops","full_name":"jonnew/cyclops","owner":{"login":"jonnew","id":1429475,"avatar_url":"https://avatars.githubusercontent.com/u/1429475?v=3","gravatar_id":"","url":"https://api.github.com/users/jonnew","html_url":"https://github.com/jonnew","followers_url":"https://api.github.com/users/jonnew/followers","following_url":"https://api.github.com/users/jonnew/following{/other_user}","gists_url":"https://api.github.com/users/jonnew/gists{/gist_id}","starred_url":"https://api.github.com/users/jonnew/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jonnew/subscriptions","organizations_url":"https://api.github.com/users/jonnew/orgs","repos_url":"https://api.github.com/users/jonnew/repos","events_url":"https://api.github.com/users/jonnew/events{/privacy}","received_events_url":"https://api.github.com/users/jonnew/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/jonnew/cyclops","description":"Precision current source, with optional optical feedback, for driving high power LEDs","fork":false,"url":"https://api.github.com/repos/jonnew/cyclops","forks_url":"https://api.github.com/repos/jonnew/cyclops/forks","keys_url":"https://api.github.com/repos/jonnew/cyclops/keys{/key_id}","collaborators_url":"https://api.github.com/repos/jonnew/cyclops/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/jonnew/cyclops/teams","hooks_url":"https://api.github.com/repos/jonnew/cyclops/hooks","issue_events_url":"https://api.github.com/repos/jonnew/cyclops/issues/events{/number}","events_url":"https://api.github.com/repos/jonnew/cyclops/events","assignees_url":"https://api.github.com/repos/jonnew/cyclops/assignees{/user}","branches_url":"https://api.github.com/repos/jonnew/cyclops/branches{/branch}","tags_url":"https://api.github.com/repos/jonnew/cyclops/tags","blobs_url":"https://api.github.com/repos/jonnew/cyclops/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/jonnew/cyclops/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/jonnew/cyclops/git/refs{/sha}","trees_url":"https://api.github.com/repos/jonnew/cyclops/git/trees{/sha}","statuses_url":"https://api.github.com/repos/jonnew/cyclops/statuses/{sha}","languages_url":"https://api.github.com/repos/jonnew/cyclops/languages","stargazers_url":"https://api.github.com/repos/jonnew/cyclops/stargazers","contributors_url":"https://api.github.com/repos/jonnew/cyclops/contributors","subscribers_url":"https://api.github.com/repos/jonnew/cyclops/subscribers","subscription_url":"https://api.github.com/repos/jonnew/cyclops/subscription","commits_url":"https://api.github.com/repos/jonnew/cyclops/commits{/sha}","git_commits_url":"https://api.github.com/repos/jonnew/cyclops/git/commits{/sha}","comments_url":"https://api.github.com/repos/jonnew/cyclops/comments{/number}","issue_comment_url":"https://api.github.com/repos/jonnew/cyclops/issues/comments{/number}","contents_url":"https://api.github.com/repos/jonnew/cyclops/contents/{+path}","compare_url":"https://api.github.com/repos/jonnew/cyclops/compare/{base}...{head}","merges_url":"https://api.github.com/repos/jonnew/cyclops/merges","archive_url":"https://api.github.com/repos/jonnew/cyclops/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/jonnew/cyclops/downloads","issues_url":"https://api.github.com/repos/jonnew/cyclops/issues{/number}","pulls_url":"https://api.github.com/repos/jonnew/cyclops/pulls{/number}","milestones_url":"https://api.github.com/repos/jonnew/cyclops/milestones{/number}","notifications_url":"https://api.github.com/repos/jonnew/cyclops/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/jonnew/cyclops/labels{/name}","releases_url":"https://api.github.com/repos/jonnew/cyclops/releases{/id}","deployments_url":"https://api.github.com/repos/jonnew/cyclops/deployments","created_at":"2013-03-24T15:07:31Z","updated_at":"2016-04-26T02:39:51Z","pushed_at":"2016-06-17T14:34:52Z","git_url":"git://github.com/jonnew/cyclops.git","ssh_url":"git@github.com:jonnew/cyclops.git","clone_url":"https://github.com/jonnew/cyclops.git","svn_url":"https://github.com/jonnew/cyclops","homepage":null,"size":353650,"stargazers_count":8,"watchers_count":8,"language":"Eagle","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":9,"mirror_url":null,"open_issues_count":5,"forks":9,"open_issues":5,"watchers":8,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/jonnew/cyclops/pulls/11"},"html":{"href":"https://github.com/jonnew/cyclops/pull/11"},"issue":{"href":"https://api.github.com/repos/jonnew/cyclops/issues/11"},"comments":{"href":"https://api.github.com/repos/jonnew/cyclops/issues/11/comments"},"review_comments":{"href":"https://api.github.com/repos/jonnew/cyclops/pulls/11/comments"},"review_comment":{"href":"https://api.github.com/repos/jonnew/cyclops/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/jonnew/cyclops/pulls/11/commits"},"statuses":{"href":"https://api.github.com/repos/jonnew/cyclops/statuses/a7356fa1f4fbb4b023793ad0f7bc9956ad3c39ee"}}}}
{"actor":{"display_login":"arrow-"}}