James: 1 revision

2021-01-13T17:24:58Z

1 revision

Jitterjames: /* Map Variables */

2016-06-20T12:12:18Z

‎Map Variables

New page

[[File:mapEditor.png |right |450px]]Maps are used to store and retrieve key-value pairs. They are a convenient way to store and access more complex values that can be used within commands. This can be extremely useful for values such as IR codes, device IDs, and API keys.

Map tables are really just sql data tables with two columns. Unlike user variables, values stored in map tables are non-volatile, meaning that they will not lose their value when VoxCommando is closed, and then restarted.

=Map Editor=
Using the map editor, we can view and edit maps directly, delete maps and create new maps.

==Accessing the Map Editor==

The map editor can be accessed two ways.

*From the Main VoxCommando window by clicking: File >> Open Map Editor
*From the [[Logical_Command_Builder|LCB]] when editing a command, by clicking the "Open Map" button.

You can select any existing map using the "Map Table" dropdown list on the right.

=Actions=
There are several core [[Actions#Map|actions]] for modifying and reading maps and their values within commands.

*Map.CreateTable
*Map.DropTable
*Map.ExportPayloadXML
*Map.Get
*Map.GetKey
*Map.Set
*Map.Query

You can also directly store matches acquired from previous actions in a command to a map using the action [[Actions#MatchToMap|Results.MatchToMap]].

=Map Variables=
Once stored in a map, individual map values can be accessed as needed within our commands.

Within the LCB, we can open the map of interest, find the value we are looking for, and simply drag and drop the value into our actions where needed. (See the videos listed below for demonstrations.)

When dragged into an action, the map value is displayed as a variable of the form: '''{M:mapName.keyName}'''.
[[File:map_variable.png]]

You could also manually type the name of the map variable in the action parameter field; however, the drag and drop method ensures the variable name will be accurate.

=Video tutorials and demos=
The following videos are the best way to familiarize yourself with VC's map functions.
*[http://www.youtube.com/watch?v=k-kwIkmPDtI&feature=share&list=PL5EB7936BE8F07625 Introduction to Maps]
*[http://www.youtube.com/watch?v=-M7htWfF3tQ&feature=youtu.be&t=12m56s Voice Control Vera Home Automation (2nd half)]
*[http://www.youtube.com/watch?v=rNUQacQblXM Fastest way to learn IR codes from your remotes with USB-UIRT], and the related tutorial:
*[http://www.youtube.com/watch?v=bcrYcS30-fU VoxCommando Tutorial - Learning IR Codes with USB-UUIRT device and voice commands]
*[http://www.youtube.com/watch?v=RdkHRnv36yY Learn IR codes from your remotes with Global Caché iTach Wifi2IR]

← Older revision	Revision as of 17:24, 13 January 2021
(No difference)

Maps - Revision history

James: 1 revision

Jitterjames: /* Map Variables */