User Tools
software:iviewer:iviewer-protocol
Differences
This shows you the differences between two versions of the page.
|
software:iviewer:iviewer-protocol [2015/03/03 01:14] jarrod [Message Format] |
software:iviewer:iviewer-protocol [2015/03/04 22:56] (current) jarrod [Digital Joins] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== iViewer Protocol ====== | ====== iViewer Protocol ====== | ||
| - | iViewer (our mobile control app) has a built in protocol for expressing UI events such as button presses and slider drags. We call this the 'iViewer Protocol'. | + | [[software:start|iViewer]] (our mobile control app) has a built in protocol for expressing UI events such as button presses and slider drags. We call this the 'iViewer Protocol'. |
| The protocol can also handle updating the UI from external control. | The protocol can also handle updating the UI from external control. | ||
| Line 9: | Line 9: | ||
| ''[identifier]=[value]\x03'' | ''[identifier]=[value]\x03'' | ||
| - | Each message is delimited with the End Of Message (EOM) hex value of 03. This delimeter will appear as ''\x03'' in all message examples throughout this document. | + | Each message is delimited with the End Of Message (EOM) hex value of 03. This delimiter will appear as ''\x03'' in all message examples throughout this document. |
| ===== Indentifiers ===== | ===== Indentifiers ===== | ||
| Line 35: | Line 35: | ||
| The following GUI elements make use of Digital joins: | The following GUI elements make use of Digital joins: | ||
| - | - Buttons | + | - Buttons - **Note: Simulation mode does NOT affect the communications. Messages are always sent for press/release events, regardless of the button state.** |
| - Changes button state depending on value (0 = inactive state, 1 = active state). | - Changes button state depending on value (0 = inactive state, 1 = active state). | ||
| - On Press, sets the join value to 1 (high). | - On Press, sets the join value to 1 (high). | ||
| Line 98: | Line 98: | ||
| ===== Password Validation ===== | ===== Password Validation ===== | ||
| - | Connections between the Viewer and Server can be password protected to prevent someone connecting to your Server without authorization. The password is set on the Server side, and in the system settings in your guiDesigner projects. | + | Connections between iViewer and Server can be password protected to prevent someone connecting to your Server without authorization. The password is set on the Server side, and in the system settings in your guiDesigner projects. |
| At the initialization of a communication session between iViewer and the Server, iViewer will send a message containing the connection password. | At the initialization of a communication session between iViewer and the Server, iViewer will send a message containing the connection password. | ||
| Line 106: | Line 106: | ||
| The message sequence goes like this: | The message sequence goes like this: | ||
| - | Connect - ion made | + | - Connection made |
| - | - Viewer sends password | + | - iViewer sends password |
| - ''p=<PasswordValueEnteredInSettings>\x03'' | - ''p=<PasswordValueEnteredInSettings>\x03'' | ||
| - If the password matches what’s in the Server settings, the Server will reply with: | - If the password matches what’s in the Server settings, the Server will reply with: | ||
| Line 207: | Line 207: | ||
| Fields definition: | Fields definition: | ||
| <join in subpage>=<join value><FIELD_SEP> | <join in subpage>=<join value><FIELD_SEP> | ||
| + | |||
| + | List Scrolling: | ||
| + | s<FIELD_SEP>index<FIELD_SEP>type<FIELD_SEP>animated | ||
| + | |||
| + | where | ||
| + | * index: the index of the row we want to scroll to | ||
| + | * type: desired position on screen: | ||
| + | * 0: position row 'index' at top of display | ||
| + | * 1: position row 'index' at middle of display | ||
| + | * 2: position row 'index' at bottom of display | ||
| + | * 3: scroll by 'index' rows (can be negative) | ||
| + | * 4: scroll at absolute pixel value 'index' (for pixel-perfect positioning) | ||
| + | * 5: position row 'index' anywhere in display | ||
| + | * animated: whether the scroll operation should be animated (1 or 0) | ||
| </sxh> | </sxh> | ||
software/iviewer/iviewer-protocol.txt · Last modified: 2015/03/04 22:56 by jarrod
