Skip to content

Commit

Permalink
controls dialog image update and missing subytpe definitions (#23)
Browse files Browse the repository at this point in the history
* controls dialog image update

- new image
- can now click to view larger image

* added missing subtype definitions

* consistent heading capitalization
  • Loading branch information
alustig3 committed Nov 20, 2023
1 parent 08a275a commit 13cfe52
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 3 deletions.
Binary file added docs/media/GUI/custom_controls_dialog.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/user-guide/graphical-user-interface.md
Expand Up @@ -31,7 +31,9 @@ The *Controls* button opens a dialog for setting/getting the value of task varia

This feature can be useful for tasks that have many variables that you would otherwise have to scroll/search through and type in edits for. The included [*example/custom_controls_dialog.py*](https://github.com/pyControl/code/blob/master/tasks/example/custom_controls_dialog.py) task is a good reference for this feature that can be viewed and run on any setup.

![custom controls dialog](../media/GUI/custom_variable_dialog.png)
<a href="../../media/GUI/custom_controls_dialog.png">
<img src="../../media/GUI/custom_controls_dialog.png"></img>
</a>

## Experiments tab

Expand Down
4 changes: 3 additions & 1 deletion docs/user-guide/pycontrol-data.md
Expand Up @@ -71,17 +71,19 @@ The `time` column indicates the time, in seconds since the start of the session,
- `user` : events triggered by the user from the controls dialog
- `api` : events triggered by the pyControl API.
- `publish` : events triggered by the task using the `publish_event` function.
- `sync` : events triggered by an [Rsync](synchronisation.md/#rsync) object

- `state` rows are generated by state transitions, the `content` column indicates the name of the state that was entered.

- `print` rows contain text output. The `content` column contains the printed text and the `subtype` column indicates what generated the print, and can be:
- `task` : print statements in the task file
- `user` : notes added to the log by the user from the controls dialog
- `api` : text printed by the API.
- `api` : text printed by the API.

- `variable` rows contain information about task variables. The `content` column contains the values of one or more task variables, as a JSON formatted string representing a dictionary of `{variable_name: variable value}` pairs. The `subtype` column indicates what operation generated the variable row, and can bes:
- `get` : variable was read using the GUI *Controls* dialog
- `user_set` : variable was set using the GUI *Controls* dialog
- `api_set` : variable was set by the API
- `print` : variable was output by the task using the `print_variables` function
- `run_start` : value of all task variables at the start of the session
- `run_end` : value of all variables at the end of the session
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Expand Up @@ -30,7 +30,7 @@ nav:
- Contributing: contributing.md

- About:
- Release Notes: about/release-notes.md
- Release notes: about/release-notes.md
- License: about/license.md

- Quick Links:
Expand Down

0 comments on commit 13cfe52

Please sign in to comment.