Phidget Control Panel: Difference between revisions

From Phidgets Support
Line 24: Line 24:
[[File:Windows_ControlPanel_NetworkService_LogLevel.PNG|link=|alt=Windows Control Panel WebService Setup]]
[[File:Windows_ControlPanel_NetworkService_LogLevel.PNG|link=|alt=Windows Control Panel WebService Setup]]


You can find the log files at {{Code|C:\ProgramData\Phidgets\Logs}}, or you can click on {{Code|Logs}} in the bottom left corner of the Control Panel window:  
You can find the log files at {{Code|C:\ProgramData\Phidgets\Logs}}, or you can click on {{Code|Logs}} in the bottom right corner of the Control Panel window:  


[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel General]]
[[File:Windows_ControlPanel_General.PNG|link=|alt=Windows Control Panel General]]

Revision as of 21:11, 17 March 2017

The Phidget Control Panel is a tool that can be used to quickly determine whether your system is able to communicate with Phidgets, and also acts as a testing and debugging tool. You can also update the firmware of attached devices, manage Phidget Dictionary entries, and remotely open and test Phidgets over the Phidget Network Service.

Windows

Once the Phidget libraries are installed using the installer, you should see the Ph.jpg icon in the taskbar. Double click on it to bring up the Phidget Control Panel. If the icon does not appear, just find and open the Phidget Control Panel from the start menu.

Phidgets Tab

Windows Control Panel General

The Phidgets tab shows the list of Phidgets currently physically attached to the computer and their firmware version. It also lists the serial number that can be used in software to open a specific Phidget when more than one of the same type are connected at once. You can double click on a Phidget device in the Phidget Control Panel to open up an example program for the device.

Windows Control Panel Example

In the above screenshot, the RFID example was opened. These examples are intended for demonstration and debugging purposes. If you have not yet already, please see the Getting Started guide for your device, which is found in its user guide. It is important to keep in mind that when an example Phidget application is opened from the Phidget Control Panel or opened from any of your Phidget applications that you develop, it holds a lock on the Phidget. This prevents any other program from accessing the Phidget. Please ensure that this example application is closed (the Phidget Control Panel itself can still be running) before running your own applications. 

Updating Firmware

If a Phidget shows up in red on the list in the Phidgets tab, it means the firmware is out of date. Double click on the Phidget to be given an option to apply the update. If you choose not to update, you can still use the control panel example afterwards.

Logging

The Phidget Control Panel keeps a log file of all errors, warnings, and other various information related to its operation. This information can be useful if you're having problems with your Phidgets but you're not sure what's going wrong. You can enable logging by going to File -> Options and checking the box beside Enable Logging. From the Level drop-down, you can select how detailed you want the output to be. Critical is the most basic setting, which will only log messages that are deemed to be very important. Verbose, on the other hand, will log everything, although it may be harder to find the messages that are important to you among all of the rest of the messages.

Windows Control Panel WebService Setup

You can find the log files at C:\ProgramData\Phidgets\Logs, or you can click on Logs in the bottom right corner of the Control Panel window:

Windows Control Panel General

There is a separate log file for the examples and the Network Service, to make it easier to find messages that are relevant to the part you're debugging. Each message in the log file will list the type of the message, the time and date, the place in the libraries the message came from, and a description. This can be very useful for figuring out why certain parts of one of the examples or the Network Service are not working properly.

Webservice Tab

The next tab is the WebService tab, which allows you to control Phidgets over a network. There are four sub-tabs. The first sub-tab is the Setup tab.

Windows Control Panel WebService Setup

Here, you can start and stop the WebService. Details are provided in the WebService section. You can determine whether the Phidget WebService is currently running by checking the status at the bottom of the window. There is also a check box that you can select to turn on verbose output, which will display useful troubleshooting information for the WebService.

The next sub-tab is the Output tab, which provides useful debugging information while you are using the WebService. This tab will only show up if the verbose output option is selected in the previous tab.

Windows Control Panel WebService Output

The Dictionary sub-tab comes next; it lists all the key-value pairs that gets created when the WebService runs. More information is provided in the Dictionary section of the General Phidget Programming page.

Windows Control WebService Dictionary

The Bonjour sub-tab gives a list of all currently attached Phidgets that are connected to the WebService. This tab will only appear if you have Bonjour installed onto your system. You can also double click on the Phidget to connect to it over the network using one or more computers, but still use the Phidget on the computer it is directly connected to.

Windows Control Panel WebService Bonjour

PhidgetSBC Tab

The last tab is the PhidgetSBC tab, which displays the complete list of any PhidgetSBCs connected to the network. This tab will be enabled if you have Bonjour installed onto your system.

Windows Control Panel WebService PhidgetSBC

You can double click on the PhidgetSBC to bring up the PhidgetSBC Administration Console log-in page in your default browser.

PhidgetSBC Admin Console

The PhidgetSBC Administration Console is where you can go to configure the PhidgetSBC. For more details, please see the PhidgetSBC section.

OS X

Once the Phidget libraries are installed using the installer, open up the System Preferences window.

OS X System Preferences

Click on the Phidgets icon in the Other section to bring up the Phidgets Preference Pane.

General Tab

OS X PreferencePane General

The general tab shows the list of Phidgets currently physically attached to the computer. You can also view the currently installed Phidget library version. You can double click on a Phidget device to open up an example program for the device.

OS X PreferencePane Example

In the above screenshot, the RFID example was opened. These examples are intended for demonstration and debugging purposes. If you have not yet already, please see the Getting Started guide for your device, which may be found in its user guide.

It is important to keep in mind that when an example Phidget application is opened from the Phidget Preference Pane or opened from any of your Phidget applications that you develop, it holds a lock on the Phidget. This prevents any other program from accessing the Phidget. Please ensure that this example application is closed(the Phidget Preference Pane can still be running) when you are running your own applications. 

Updating Firmware

If a Phidget shows up in red on the list in the general tab, it means the firmware is out of date. Double click on the Phidget to be given an option to apply the update. If you choose not to update, you can still use the example program afterwards.

Web Service Tab

The next tab is the Web Service tab, which allows you to control Phidgets over a network.

OS X PreferencePane WebService Stopped

Here, you can start and stop the WebService. Details are provided in the WebService section. This screen also tells you whether the Phidget WebService is currently running.

Labels Tab

The next tab is the Labels tab. In this section, you can view the currently assigned labels of any Phidget attached to your computer. It is also possible to set the labels of Phidgets here too. You might want to set a label to a Phidget device because you can refer to it by its label as opposed to its serial number.

OS X PreferencePane WebService Labels Local

You can also view the labels of any Phidget connected through the WebService. You cannot change the label of a Phidget connected to a Windows computer, because of the way the Windows USB drivers are programmed.

OS X PreferencePane WebService Labels Remote

Bonjour Tab

The Bonjour tab gives a list of all currently attached Phidgets that are connected to the WebService. You can also double click on the Phidget to connect to it over the network using one or more computers, but still use the Phidget on the computer it is directly connected to.

OS X PreferencePane Bonjour

PhidgetSBC Tab

The last tab is the PhidgetSBC tab, which displays the complete list of PhidgetSBCs connected to the network.

OS X PreferencePane PhidgetSBC

You can double click on the PhidgetSBC to bring up the PhidgetSBC Administration Console log-in page in your default browser.

PhidgetSBC Admin Console

The PhidgetSBC Administration Console is where you can go to configure the PhidgetSBC. For more details, please see the PhidgetSBC section.

Linux

There is no graphical interface like the control panel or preferences pane on Linux.

See the OS - Linux page for more information on how to get started with Phidgets on Linux.