CommandFusion Wiki

Documentation Resources

User Tools

Site Tools


software:system-commander:quick-start-guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

software:system-commander:quick-start-guide [2012/12/21 02:49]
aaron
software:system-commander:quick-start-guide [2014/07/24 00:06] (current)
aaron [Contents]
Line 1: Line 1:
 ====== System Commander Quick Start Guide ====== ====== System Commander Quick Start Guide ======
-A video version of this quick start guide is [[https://​www.youtube.com/​watch?​v=w-UwmiZx1cU|available here]]. +A video version of this quick start guide is [[https://​www.youtube.com/​watch?​v=w-UwmiZx1cU|available here]].\\ 
- +{{url>http://www.youtube.com/embed/​w-UwmiZx1cU 560px,315px noscroll noborder alignment|alternate-text}}
-<WRAP center round important 60%> +
-This page is under construction and may not include all required information. +
-</WRAP>+
  
 +===== Contents =====
 +  * [[software:​system-commander:​quick-start-guide#​introduction-what-is-system-commander|Introduction]] ​
 +  * [[software:​system-commander:​quick-start-guide##​installation|Installation]]
 +  * [[software:​system-commander:​quick-start-guide#​overview-of-interface|Interface Overview]]
 +  * [[software:​system-commander:​quick-start-guide#​auto-discovery|Auto Discovery]]
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-2#​updating-firmware|Updating Firmware]]
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-2#​automatic-id-conflict-resolution|Auto ID Conflict Resolution]]
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-2#​basic-configuration-of-device-properties|Basic Configuration]] ​
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-2#​port-testing|Port Testing]] ​
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-3#​basic-rules|Basic Rules]] ​
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-4#​basic-scheduling|Basic Scheduling]] ​
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-4#​ir-file-management|IR File Management]] ​
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-4#​test-commands|Test Commands]] ​
 +  * [[software:​system-commander:​quick-start-guide:​quick-start-page-4#​creating-an-iviewer-gui-for-commandfusion-hardware|Creating an iViewer GUI for CommandFusion Hardware]]
 ===== Introduction - What is System Commander? ===== ===== Introduction - What is System Commander? =====
 System Commander is a Windows application used to configure [[hardware:​start|CommandFusion automation hardware]].\\ System Commander is a Windows application used to configure [[hardware:​start|CommandFusion automation hardware]].\\
Line 13: Line 24:
 All communications handled by System Commander use the openly documented [[hardware:​cflink|CFLink protocol]], available to any user of CommandFusion hardware.\\ All communications handled by System Commander use the openly documented [[hardware:​cflink|CFLink protocol]], available to any user of CommandFusion hardware.\\
  
 +[[http://​www.youtube.com/​watch?​feature=player_detailpage&​v=w-UwmiZx1cU#​t=11s|Click here to see this section in a video guide]].
 ===== Installation ===== ===== Installation =====
 System Commander can be [[http://​www.commandfusion.com/​systemcommander.html|downloaded from the CommandFusion website]]. \\ System Commander can be [[http://​www.commandfusion.com/​systemcommander.html|downloaded from the CommandFusion website]]. \\
 It is a portable program that does not require installation. Simply unzip it to any location on your computer and run the executable file. It is a portable program that does not require installation. Simply unzip it to any location on your computer and run the executable file.
  
 +[[http://​www.youtube.com/​watch?​feature=player_detailpage&​v=w-UwmiZx1cU#​t=46s|Click here to see this section in a video guide.]]
 ===== Overview of Interface ===== ===== Overview of Interface =====
  
Line 25: Line 38:
  
 Below the buttons is a tree of automatically discovered CFLink devices which can be selected to bring up their configuration options. Below the buttons is a tree of automatically discovered CFLink devices which can be selected to bring up their configuration options.
-{{ :​software:​system-commander:​cf_link_devices.png?​nolink&700 |}}+{{ :​software:​system-commander:​cf_link_devices.png?​direct&700 |}}
  
 Below the device tree is a form used for sending test commands via the CFLink network.\\ Below the device tree is a form used for sending test commands via the CFLink network.\\
-{{ :​software:​system-commander:​test_commands.png?​nolink&700 |}}+{{ :​software:​system-commander:​test_commands.png?​direct&700 |}}
 The main area of the program is used to configure and test the selected CFLink device. When you select a device in the tree, the main section will fill with a list of tabs relevant to the device. Each tab contains options and tools for configuring and testing specific aspects of the device, such as configuring general properties, setting up rules or schedules, or testing connectivity of relays, I/O ports, and other control ports.\\ The main area of the program is used to configure and test the selected CFLink device. When you select a device in the tree, the main section will fill with a list of tabs relevant to the device. Each tab contains options and tools for configuring and testing specific aspects of the device, such as configuring general properties, setting up rules or schedules, or testing connectivity of relays, I/O ports, and other control ports.\\
-{{ :​software:​system-commander:​main_area.png?​nolink&700 |}}+{{ :​software:​system-commander:​main_area.png?​direct&700 |}}
  
 The last section across the bottom of the interface is the communication log. This area logs all incoming and outgoing traffic in an easy to read format. The log is great for debugging communications as well as copying commands for use outside of System Commander.\\ The last section across the bottom of the interface is the communication log. This area logs all incoming and outgoing traffic in an easy to read format. The log is great for debugging communications as well as copying commands for use outside of System Commander.\\
-{{ :​software:​system-commander:​communication_log.png?​nolink&​700 |}} +{{ :​software:​system-commander:​communication_log.png?​direct&​700 |}} 
-{{ :​software:​system-commander:​cf_link_devices.png?​direct&​300 |}}+\\ 
 +[[http://​www.youtube.com/​watch?​feature=player_detailpage&​v=w-UwmiZx1cU#​t=61s|Click here to see this section in a video guide.]] 
 +===== Auto Discovery ===== 
 +The automatic discovery feature allows you to scan for CFLink devices on the network, select them and configure them.\\ 
 +\\ 
 +System Commander can automatically discover devices in two ways, the first is via the local network using UDP broadcast communications. To do this you must have a CommandFusion LAN Bridge. \\ 
 +\\ 
 +The second way is via RS232, this can be done with any CommandFusion device that has an on-board RS232 port.\\ 
 +{{ :​software:​system-commander:​automatic_discovery_mode.png?​direct&​500 |}} 
 + 
 +==== UDP Discovery ==== 
 + 
 +Lets look at the UDP discovery mode first. So as I mentioned, for any hardware to be detected in this mode, we must be have a LAN Bridge connected to our network. If you do not have a DHCP server enabled on your network, the LAN Bridge will default to a self assigned IP address. \\ 
 +{{ :​software:​system-commander:​auto_discovery.swf?​700x394 |}} 
 + 
 +We then need to check that System Manager is configured for UDP discovery. To do this, on the main menu bar choose ''​network'',​ then ''​settings''​ from the main menu.\\ 
 +{{ :​software:​system-commander:​system_commander_network_settings.png?​nolink ​|}} 
 +Make sure that ''​Ethernet communication mode''​ is enabled and ''​UDP''​ is selected.\\ 
 +Other settings in this window are not required for UDP auto discovery.\\ 
 +{{ :​software:​system-commander:​system_commander_network_settings_window.png?​nolink |}}  
 + 
 +After we have configure our UDP settings, we can go back to the main window and click the ''​Offline''​ button, this will switch us to online mode and begin the discovery process.\\ 
 +This takes only a second or two, and once System Commander has picked up the LAN Bridge, it will also discover all other devices connected to it on the CFLink network.\\ 
 +{{ :​software:​system-commander:​system_commander_online_button.png?​nolink |}} 
 +We can also enable online mode by clicking on ''​Network'',​ then ''​Go Online''​. Or using the F12 shortcut key. 
 + 
 +==== RS232 Discovery ==== 
 + 
 +If we want to use the RS232 discovery feature we need to do things a little differently. First we need to make sure that the device we are connecting to is in program mode. This is done by pressing a button on top of the CommandFusion hardware labelled Setup, or COM Mode - depending which piece of hardware you are using. Now we connect the RS232 port on the device to the COM port on your computer. If you don't have any COM ports available, then you can use a third party RS232 to USB adapter.\\ 
 +{{ :​software:​system-commander:​commandfusion_rs232_auto_discovery.png?​direct&700 |}} 
 +\\ 
 +In System Commander, choose ''​Network'',​ then ''​Settings''​ from the menu.\\ ​ 
 +{{ :​software:​system-commander:​system_commander_network_settings.png?​nolink |}} 
 + 
 +Ensure that ''​COM Port Communication Mode''​ is enabled. Then select the appropriate COM port that your device is connected too.\\ 
 +{{ :​software:​system-commander:​system_commander_network_settings_window_rs232.png?​direct&​300 |}} 
 + 
 +Once again, we then switch to online mode and the autodiscover process will begin. \\ 
 +It will not only pick up the device you are directly connected too, but it will also discover any other devices connected via the CFLink network.\\ 
 +\\ 
 +==== CFLink Devices Tree ==== 
 + 
 +Devices with a green indicator are working correctly. Devices without valid firmware installed are shown with a red indicator. It may take a little longer for a device with invalid or no firmware to appear in your hardware tree as these devices will not respond to discovery requests but instead auto-announce themselves on power up and on regular intervals.\\ 
 +{{ :​software:​system-commander:​system_commander_cf_link_devices_with_error.png?​direct |}} 
 +\\ 
 +[[http://​www.youtube.com/​watch?​feature=player_detailpage&​v=w-UwmiZx1cU#​t=147s|Click here to see this section in a video guide.]] 
 +===== Page 2 ===== 
 +This quick start guide is broken up into multiple pages. [[software:​system-commander:​quick-start-guide:​quick-start-page-2|Click here to go to page 2]].
software/system-commander/quick-start-guide.1356058144.txt.gz · Last modified: 2012/12/21 02:49 by aaron