Phidget Control Panel: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
 
(54 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The '''Phidget Control Panel''', (or the '''Phidget Preference Pane''' on OS X) 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 webservice.  
[[Category:Overview]]
==Getting Started==
The Phidget Control Panel is a powerful tool that will help you develop your Phidget applications. With the control panel, you can view all Phidgets attached to your machine/network, graph data from your devices, upgrade your firmware, and more!
 
 
We recommend using the '''Windows''' version of the Phidget Control Panel. There are macOS and browser-based options available, however, their functionality is limited.


==Windows==
==Windows==
===Install===
If you haven't already, follow the [[OS_-_Windows#Getting started with Windows|getting started with Windows]] guide. There, you will install the Phidget libraries, including the Phidget Control Panel.
===Phidgets Tab===
After opening the Phidget Control Panel, you will see something similar to this:
[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General|center]]
By default, the Phidgets tab will list any Phidget that is connected to your machine, as well as the following information:
*'''Serial number:''' allows you to differentiate between similar Phidgets.
*'''Channel:''' allows you to differentiate between similar objects on a Phidget.
*'''Version number:''' corresponds to the firmware version your Phidget is running.
To add/remove information from the Phidget Control Panel, right-click on one of the column headers:
[[File:Controlpanel_windows_showmore.png|link=|center]]
If an entry has a '''+''' symbol next to it, it can be expanding by clicking on the symbol, or double-clicking the entry:
[[File:Controlpanel_expand.png|link=|center]]
====Running Applications====
Every Phidget has an example application, double-click on a Phidget channel to run the program. You can also right-click on a Phidget channel and click ''Open Selected Channel''.
[[File:Controlpanel_openapplication.png|500px|link=https://www.phidgets.com/docs/images/b/bd/Controlpanel_openapplication.png|center]]
These examples are intended for demonstration and debugging purposes; you'll eventually want to write your own program using our code samples for your preferred programming language.
====Upgrading Firmware====
If a Phidget has a blue arrow icon ([[File:Win_update_firm.jpg]]) next to it, it means the firmware is out of date. Right-click on the row and select ''Upgrade Firmware''.
[[Image:ControlpanelFWup.jpg|link=|center]]
The latest version will be auto-selected and you can simply click '''Upgrade''' to complete.
[[Image:Controlpanel_firmwareupgradescreen.png|link=|center]]
====Downgrading Firmware====
Firmware upgrades include important bug fixes and performance improvements, but there are some situations where you may want to revert to an old version of the firmware (e.g. when an application you're using is compiled using an older version of the Phidget library that doesn't recognize the new firmware).
You can downgrade by right-clicking on the device's row and selecting ''Downgrade Firmware''.
[[Image:ControlpanelFWdown.jpg|link=]]
You can then select a specific firmware version.
[[Image:Controlpanel_firmwaredowngradescreen.png|link=|center]]
==== Graphing and Data Logging ====
To plot data, open the channel for your device and click on the [[Image:plot.jpg|link=]] icon next to the data type that you want to plot. This will open up a new window:
[[Image:plot2.jpg|link=|850px]]
===== Filtering =====
You can perform filtering on the raw data in order to reduce noise in your graph. For more information, see the [[Control Panel Graphing]] page.
===== Graph Type =====
You can perform a transform on the incoming data to get different graph types that may provide insights into your sensor data. For more information on how to use these graph types, see the [[Control Panel Graphing]] page.
====Error Logging====
The Phidget Control Panel keeps a log file of all errors, warnings, and other information related to its operation. This information can provide useful insight when your device/system is not behaving as expected. To enable logging, first navigate to ''File'' > ''Options...''
[[File:Controlpanel_windows_fileoptions.png|link=|center]]
Next, check the box beside ''Enable Logging''. For more information about log levels, view our [https://www.phidgets.com/docs/Logging_Details logging details] page.
[[File:Windows_ControlPanel_NetworkService_LogLevel.PNG|link=|alt=Windows Control Panel Network Server Setup|center]]
To view the log files, click on ''Help > Open Logs Folder'' in the menu at the top. You can also find it by navigating to the following location:
*C:/ProgramData/Phidgets/logs
[[File:Controlpanel_windows_loglocation.png|link=|alt=Windows Control Panel General|center]]
There are separate log files with different purposes:
* '''Phidget22Manager.log''' - This is the main log file for all Phidgets you access through the Phidget Control Panel.
* '''Phidget22NetworkServer_networkserver.log''' - If you have a Network Server running, this is the main log file for all activity on the server.
* '''Phidget22NetworkServer_access.log''' - This file logs requests made on the webpage hosted by your Network Server.
====Setting VINT Speed====
Right-click on a Phidget to set the VINT Speed.
[[File:Controlpanel_setspeed.png|link=|center]]
You can see the current VINT Speed in the [[#View Device/Channel Properties|properties menu]].
[[File:Deviceproperties_example.png|link=|center]]
====Setting a Label====
Right-click on a Phidget to set a label. See [[Addressing_Phidgets#Label|using a label]] for more information about how to use labels with Phidgets.
[[File:Controlpanel_windows_setlabel.png|link=|center]]
====Set Hub Port Power====
Power to VINT Hub ports can be controlled programmatically. Right-click on a hub port to turn the power on/off. For more information, visit the [https://www.phidgets.com/?view=api Phidget API], select your VINT Hub, and select '''USB''' as the interface type.
[[File:Controlpanel_hubportpower.png|link=|center]]
====View Device/Channel Properties====
Right-click on a device/channel to view its properties.
[[File:Controlpanel_deviceproperties.png|link=|center]]
====Access Device-Specific Options====
Some devices have other options that can be accessed through the Phidget Control Panel. For example, the [https://www.phidgets.com/?&prodid=1205 PhidgetSpatial Precision 3/3/3] shown in the example below has a Magnetometer Calibration program that can be accessed through the control panel.
[[File:Controlpanel_devicespecificoptions.png|link=|center]]
===Network Server Tab===
To get started, click on the Network Server tab:
[[File:Windows_ControlPanel_NetworkService_Setup_Stopped.jpg|link=|center|alt=Windows Control Panel Network Server Setup]]
====Settings====
*'''Startup Type:''' determines when the Phidget Network Server will start.
**'''Automatic:''' the Phidget Network Server will start automatically when Windows boots.
**'''Manual:''' the Phidget Network Server will start only when you click the ''Start'' button at the bottom of the Window, or, if another service starts it.
**'''Disabled:''' mode means the Phidget Network Server will stay off, regardless of what tries to start it.
====Phidget Server Settings====
*'''Enabled:''' enable the Phidget server. When you enable the Phidget Server, other computers on the network will be able to access the Phidgets that are connected to your computer.
*'''Publish:''' enable/disable mDNS. See the [[Phidget Network Server#Connecting to a Network Server|connecting to a Phidget Network Server]] for more information.
*'''Server Name:''' your server name will allow you to identify your Phidget Server from others on the network.
*'''Password (optional):''' prevent unauthorized computers on the network from accessing the Phidgets connected to your computer by setting a password.
*'''Log Level:''' defaults to ''Info''. See [[#Error Logging|logging]] section above for more information.
*'''Port:''' The port used by the Phidget Network Server (defaults to 5661).
====Webserver Settings====
*'''Enabled:''' enable the Webserver. The Webserver allows you to host a webpage that will have access to Phidgets through languages like [[Language_-_JavaScript|JavaScript]].
*'''Docroot:''' specifies the docroot path. This is where your webpage files will live and any/all additional libraries.
*'''Port:''' The port used by the Webserver (defaults to 8989).
====Dictionaries Settings====
*'''Enable User Dictionaries:''' in order to create/use a Phidget Dictionary with the Phidget Control Panel, make sure this setting is enabled.
*'''Enable Monitoring/control Dictionary:''' by enabling this setting, you can view incoming/outgoing traffic related to your Phidget Network Server. Here is an example:
[[File:Controlpanel_windows_servermonitoring.png|link=|center]]
====Adding a Phidget Dictionary====
Phidget Dictionaries are an extremely powerful tool when working with Phidgets. See the [[Phidget Dictionary]] page for more information.


Once the [[OS_-_Windows#Quick_Downloads|Phidget libraries]] are installed using the installer, you should see the [[File: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.


===General Tab===
Creating a Phidget Dictionary is quick and easy with the Phidget Control Panel. First, specify a serial number for your Dictionary, and then give it a name (if you don't specify a serial number, a default will be provided).


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


The general 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 view the currently installed Phidget library version at the top, and below there is a checkbox option to choose whether the Phidget Control Panel is to be started up automatically once Windows boots up. You can double click on a Phidget device in the Phidget Control Panel to open up an example program for the device.
Next, click on the ''Config...'' button. Here you can create a key-value pair for your Dictionary:
[[File:Controlpanel_windows_createdictionary.png|link=|center]]


[[File:Windows ControlPanel Example.PNG|link=|alt=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 [[:Category:UserGuide|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) when you are running your own applications. 
After you create your key-value pair, make sure your Dictionary is enabled and then start your Phidget Network Server (or Restart, if it is already running). Navigate to the Phidgets tab and you will see your new Dictionary:
[[File:Controlpanel_windows_dictionary.png|link=|center]]


====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 control panel example afterwards.
You can now access the Phidget Dictionary from any machine on the network.


===Webservice Tab===
===Network Phidgets Tab===
The last tab is the Network Phidgets tab, which displays a complete list of any Phidget SBCs or Wireless VINT Hubs connected to your network.
[[File:Phidgetsbc_windowscontrolpanel.PNG|link=|center]]


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


[[File:Windows ControlPanel WebService Setup Running.PNG|link=|alt=Windows Control Panel WebService Setup]]
Just like the Phidgets tab, you can right-click on any of the column headers for view options:
[[File:Phidgetsbc_windowscontrolpanel_showmore.PNG|link=|center]]


Here, you can start and stop the WebService. Details are provided in the [[#WebService | 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 {{Code|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.  
You can also double-click on a device to bring up its web interface.


[[File:Windows ControlPanel WebService Output.PNG|link=|alt=Windows Control Panel WebService Output]]
====Wireless VINT Hub Firmware Upgrade====
If your Wireless VINT Hub has out-of-date firmware, a blue arrow icon ([[File:Win_update_firm.jpg]]) will appear in its row.
[[File:Controlpanel_networktab_upgrade.png|link=|center]]


The {{Code|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 [[General Phidget Programming#Using the Dictionary|Dictionary]] section of the [[General Phidget Programming|General Phidget Programming]] page.


[[File:Windows ControlPanel WebService Dictionary.PNG|link=|alt=Windows Control WebService Dictionary]]
You can double-click on the entry for information about how to upgrade your device.
[[File:Controlpanel_networktab_upgradescreen.png|link=|center]]


The {{Code|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 [http://www.apple.com/support/downloads/bonjourforwindows.html 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.
==macOS==
===Install===
If you haven't already, follow the [[OS_-_macOS#Getting started with macOS|getting started with macOS]] guide. There, you will install the Phidget libraries, including the Phidget Control Panel.


[[File:Windows ControlPanel WebService Bonjour.PNG|link=|alt=Windows Control Panel WebService Bonjour]]
===Phidgets Tab===
After opening the Phidget Control Panel, you will see something similar to this:
[[File:OSX ControlPanel General.png|600px|link=https://www.phidgets.com/docs/images/7/7f/OSX_ControlPanel_General.png|alt=macOS Control Panel General|center]]


===PhidgetSBC Tab===


The last tab is the {{Code|PhidgetSBC}} tab, which displays the complete list of any PhidgetSBCs connected to the network. This tab will be enabled if you have [http://www.apple.com/support/downloads/bonjourforwindows.html Bonjour] installed onto your system.
The Phidgets tab will list all Phidgets (and associated objects) that are connected to your machine, as well as the following information:
*'''Serial number:''' allows you to differentiate between similar Phidgets.
*'''Channel:''' allows you to differentiate between similar objects on a Phidget.
*'''Version number:''' corresponds to the firmware version your Phidget is running.


[[File:Windows ControlPanel WebService PhidgetSBC.PNG|link=|alt=Windows Control Panel WebService PhidgetSBC]]
====Running Applications====
Every Phidget has an example program, double-click on a Phidget to run the program:
[[File:Controlpanel_mac_openapplication2.png|link=https://www.phidgets.com/docs/images/1/11/Controlpanel_mac_openapplication2.png|center|600px]]


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


[[File:PhidgetSBCAdminConsole.PNG|link=|alt=PhidgetSBC Admin Console]]
'''Note:''' important features for your device may be missing on the macOS version of the Phidget Control Panel. We recommend using the Windows version of the Phidget Control Panel when possible.


The PhidgetSBC Administration Console is where you can go to configure the PhidgetSBC. For more details, please see the [[1073 User Guide#Getting Started | PhidgetSBC]] section.
====Upgrading 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 the option to apply the update.  


==OS X==
[[File:Controlpanel_mac_firmwareupgrade.png|link=https://www.phidgets.com/docs/images/9/93/Controlpanel_mac_firmwareupgrade.png|center|600px]]


Once the Phidget libraries are installed using the installer, open up the {{Code|System Preferences}} window.
Simply click '''Upgrade''' to complete.
[[File:Controlpanel_mac_upgradescreen.png|link=https://www.phidgets.com/docs/images/9/9d/Controlpanel_mac_upgradescreen.png|center|500px]]


[[File:OSX System Preferences.png|link=|alt=OS X System Preferences]]
====Downgrading Firmware====
This functionality is not supported in the macOS version of the Phidget Control Panel.


Click on the {{Code|Phidgets}} icon in the {{Code|Other}} section to bring up the Phidgets Preference Pane.
==== Graphing and Data Logging ====
This functionality is not supported in the macOS version of the Phidget Control Panel.


===General Tab===
====Error Logging====
The Phidget Control Panel keeps a log file of all errors, warnings, and other 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. To view the log file, open the ''Console'' application under ''Applications'' > ''Utilities''
[[File:Controlpanel_mac_console.png|600px|link=|center]]


[[File:OSX PreferencePane General.png|link=|alt=OS X PreferencePane General]]


The {{Code|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.
After opening the ''Console'' application, navigate to user logs (''~/Library/Logs'') on the left menu. You will likely have a list of logs from various applications. After finding the Phidget logs, you will see something like this:
[[File:Controlpanel_mac_log.png|link=https://www.phidgets.com/docs/images/2/24/Controlpanel_mac_log.png|center|600px]]


[[File:OSX PreferencePane Example.png|link=|alt=OS X PreferencePane Example]]
====Setting VINT Speed====
This functionality is not supported in the macOS version of the Phidget Control Panel.


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 [[:Category:UserGuide|user guide]].
====Setting a Label====
This functionality is not supported in the macOS version of the Phidget Control Panel.


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. 
====Set Hub Port Power====
This functionality is not supported in the macOS version of the Phidget Control Panel.


====Updating Firmware====
====View Device/Channel Properties====
This functionality is not supported in the macOS version of the Phidget Control Panel.


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.
====Access Device-Specific Options====
This functionality is not supported in the macOS version of the Phidget Control Panel.


===Web Service Tab===
===Network Server Tab===
To get started, click on the Network Server tab:


The next tab is the {{Code|Web Service}} tab, which allows you to control Phidgets over a network.  
[[File:Macos_networkserver.png|600px|link=https://www.phidgets.com/docs/images/0/0c/Macos_networkserver.png|center]]


[[File:OSX PreferencePane Webservice Stopped.png|link=|alt=OS X PreferencePane WebService Stopped]]


Here, you can start and stop the WebService. Details are provided in the [[#WebService | WebService]] section. This screen also tells you whether the Phidget WebService is currently running.  
====Settings====
*'''Start Network Server''': start or stop the Network Server. The text to the right of the button will display the current status of the Network Server.  
*'''Start Automatically on Boot''': the Network Server will start automatically when the computer boots. Otherwise, you'll have to manually start the Network Server every time you want to use it.


===Labels Tab===


The next tab is the {{Code|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.
====Phidget Server Settings====
*'''Enabled:''' enable the Phidget server. When you enable the Phidget Server, other computers on the network will be able to access the Phidgets that are connected to your computer.
*'''Publish:''' enable/disable mDNS. See the [[Phidget Network Server#Connecting to a Network Server|connecting to a Phidget Network Server]] for more information.
*'''Server Name:''' your server name will allow you to identify your Phidget Server from others on the network.
*'''Password (optional):''' prevent unauthorized computers on the network from accessing the Phidgets connected to your computer by setting a password.
*'''Port:''' The port used by the Phidget Network Server (defaults to 5661).


[[File:OSX PreferencePane Labels Local.png|link=|alt=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.
====Webserver Settings====
*'''Enabled:''' enable the Webserver. The Webserver allows you to host a webpage that will have access to Phidgets through languages like [[Language_-_JavaScript|JavaScript]].
*'''Docroot:''' specifies the docroot path. This is where your webpage files will live and any/all additional libraries.
*'''Port:''' The port used by the Webserver (defaults to 8989).


[[File:OSX PreferencePane Labels Remote.png|link=|alt=OS X PreferencePane WebService Labels Remote]]


===Bonjour Tab===
====Dictionaries Settings====
*'''Enable User Dictionaries:''' in order to create/use a Phidget Dictionary with the Phidget Control Panel, make sure this setting is enabled.
*'''Enable Monitoring/control Dictionary:''' by enabling this setting, you can view incoming/outgoing traffic related to your Phidget Network Server. Currently, you can view this information on a Windows machine only.


The {{Code|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.
====Adding a Phidget Dictionary====
Phidget Dictionaries are an extremely powerful tool when working with Phidgets. See the [[Phidget Dictionary]] page for more information.


[[File:OSX PreferencePane Bonjour.png|link=|alt=OS X PreferencePane Bonjour]]


===PhidgetSBC Tab===
Creating a Phidget Dictionary is quick and easy with the Phidget Control Panel. Simply press the '''+''' button and specify a name and serial number for your Dictionary:
[[File:Controlpanel_macos_createdictionary.png|link=https://www.phidgets.com/docs/images/d/dc/Controlpanel_macos_createdictionary.png|center|600px]]


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


[[File:OSX PreferencePane PhidgetSBC.png|link=|alt=OS X PreferencePane PhidgetSBC]]
Next, make sure your Dictionary is enabled and then start your Phidget Network Server (or Restart, if it is already running). Navigate to the Phidgets tab and you will see your new Dictionary:
[[File:Contorlpanel_macos_dictionary.png|link=https://www.phidgets.com/docs/images/3/33/Contorlpanel_macos_dictionary.png|center|600px]]


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


[[File:PhidgetSBCAdminConsole.PNG|link=|alt=PhidgetSBC Admin Console]]
You can now access the Phidget Dictionary from any machine on the network.


The PhidgetSBC Administration Console is where you can go to configure the PhidgetSBC. For more details, please see the [[1073 User Guide| PhidgetSBC]] section.
===Network Phidgets Tab===
The last tab is the Network Phidgets tab, which displays a complete list of any Phidget SBC or Wireless VINT Hub connected to your network.


==Linux==
[[File:Phidgetsbc_maccontrolpanel.png|link=https://www.phidgets.com/docs/images/8/8f/Phidgetsbc_maccontrolpanel.png|center|600px]]


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.
You can also double-click on a device to bring up its web interface.

Latest revision as of 22:16, 3 August 2023

Getting Started

The Phidget Control Panel is a powerful tool that will help you develop your Phidget applications. With the control panel, you can view all Phidgets attached to your machine/network, graph data from your devices, upgrade your firmware, and more!


We recommend using the Windows version of the Phidget Control Panel. There are macOS and browser-based options available, however, their functionality is limited.

Windows

Install

If you haven't already, follow the getting started with Windows guide. There, you will install the Phidget libraries, including the Phidget Control Panel.

Phidgets Tab

After opening the Phidget Control Panel, you will see something similar to this:

Windows Control Panel General


By default, the Phidgets tab will list any Phidget that is connected to your machine, as well as the following information:

  • Serial number: allows you to differentiate between similar Phidgets.
  • Channel: allows you to differentiate between similar objects on a Phidget.
  • Version number: corresponds to the firmware version your Phidget is running.


To add/remove information from the Phidget Control Panel, right-click on one of the column headers:

Controlpanel windows showmore.png


If an entry has a + symbol next to it, it can be expanding by clicking on the symbol, or double-clicking the entry:

Controlpanel expand.png

Running Applications

Every Phidget has an example application, double-click on a Phidget channel to run the program. You can also right-click on a Phidget channel and click Open Selected Channel.

Controlpanel openapplication.png


These examples are intended for demonstration and debugging purposes; you'll eventually want to write your own program using our code samples for your preferred programming language.

Upgrading Firmware

If a Phidget has a blue arrow icon (Win update firm.jpg) next to it, it means the firmware is out of date. Right-click on the row and select Upgrade Firmware.

ControlpanelFWup.jpg


The latest version will be auto-selected and you can simply click Upgrade to complete.

Controlpanel firmwareupgradescreen.png

Downgrading Firmware

Firmware upgrades include important bug fixes and performance improvements, but there are some situations where you may want to revert to an old version of the firmware (e.g. when an application you're using is compiled using an older version of the Phidget library that doesn't recognize the new firmware).


You can downgrade by right-clicking on the device's row and selecting Downgrade Firmware.

ControlpanelFWdown.jpg


You can then select a specific firmware version.

Controlpanel firmwaredowngradescreen.png

Graphing and Data Logging

To plot data, open the channel for your device and click on the Plot.jpg icon next to the data type that you want to plot. This will open up a new window:

Plot2.jpg

Filtering

You can perform filtering on the raw data in order to reduce noise in your graph. For more information, see the Control Panel Graphing page.

Graph Type

You can perform a transform on the incoming data to get different graph types that may provide insights into your sensor data. For more information on how to use these graph types, see the Control Panel Graphing page.

Error Logging

The Phidget Control Panel keeps a log file of all errors, warnings, and other information related to its operation. This information can provide useful insight when your device/system is not behaving as expected. To enable logging, first navigate to File > Options...

Controlpanel windows fileoptions.png


Next, check the box beside Enable Logging. For more information about log levels, view our logging details page.

Windows Control Panel Network Server Setup


To view the log files, click on Help > Open Logs Folder in the menu at the top. You can also find it by navigating to the following location:

  • C:/ProgramData/Phidgets/logs


Windows Control Panel General


There are separate log files with different purposes:

  • Phidget22Manager.log - This is the main log file for all Phidgets you access through the Phidget Control Panel.
  • Phidget22NetworkServer_networkserver.log - If you have a Network Server running, this is the main log file for all activity on the server.
  • Phidget22NetworkServer_access.log - This file logs requests made on the webpage hosted by your Network Server.

Setting VINT Speed

Right-click on a Phidget to set the VINT Speed.

Controlpanel setspeed.png


You can see the current VINT Speed in the properties menu.

Deviceproperties example.png

Setting a Label

Right-click on a Phidget to set a label. See using a label for more information about how to use labels with Phidgets.

Controlpanel windows setlabel.png

Set Hub Port Power

Power to VINT Hub ports can be controlled programmatically. Right-click on a hub port to turn the power on/off. For more information, visit the Phidget API, select your VINT Hub, and select USB as the interface type.

Controlpanel hubportpower.png

View Device/Channel Properties

Right-click on a device/channel to view its properties.

Controlpanel deviceproperties.png

Access Device-Specific Options

Some devices have other options that can be accessed through the Phidget Control Panel. For example, the PhidgetSpatial Precision 3/3/3 shown in the example below has a Magnetometer Calibration program that can be accessed through the control panel.

Controlpanel devicespecificoptions.png

Network Server Tab

To get started, click on the Network Server tab:

Windows Control Panel Network Server Setup


Settings

  • Startup Type: determines when the Phidget Network Server will start.
    • Automatic: the Phidget Network Server will start automatically when Windows boots.
    • Manual: the Phidget Network Server will start only when you click the Start button at the bottom of the Window, or, if another service starts it.
    • Disabled: mode means the Phidget Network Server will stay off, regardless of what tries to start it.


Phidget Server Settings

  • Enabled: enable the Phidget server. When you enable the Phidget Server, other computers on the network will be able to access the Phidgets that are connected to your computer.
  • Publish: enable/disable mDNS. See the connecting to a Phidget Network Server for more information.
  • Server Name: your server name will allow you to identify your Phidget Server from others on the network.
  • Password (optional): prevent unauthorized computers on the network from accessing the Phidgets connected to your computer by setting a password.
  • Log Level: defaults to Info. See logging section above for more information.
  • Port: The port used by the Phidget Network Server (defaults to 5661).


Webserver Settings

  • Enabled: enable the Webserver. The Webserver allows you to host a webpage that will have access to Phidgets through languages like JavaScript.
  • Docroot: specifies the docroot path. This is where your webpage files will live and any/all additional libraries.
  • Port: The port used by the Webserver (defaults to 8989).


Dictionaries Settings

  • Enable User Dictionaries: in order to create/use a Phidget Dictionary with the Phidget Control Panel, make sure this setting is enabled.
  • Enable Monitoring/control Dictionary: by enabling this setting, you can view incoming/outgoing traffic related to your Phidget Network Server. Here is an example:
Controlpanel windows servermonitoring.png

Adding a Phidget Dictionary

Phidget Dictionaries are an extremely powerful tool when working with Phidgets. See the Phidget Dictionary page for more information.


Creating a Phidget Dictionary is quick and easy with the Phidget Control Panel. First, specify a serial number for your Dictionary, and then give it a name (if you don't specify a serial number, a default will be provided).


Next, click on the Config... button. Here you can create a key-value pair for your Dictionary:

Controlpanel windows createdictionary.png


After you create your key-value pair, make sure your Dictionary is enabled and then start your Phidget Network Server (or Restart, if it is already running). Navigate to the Phidgets tab and you will see your new Dictionary:

Controlpanel windows dictionary.png


You can now access the Phidget Dictionary from any machine on the network.

Network Phidgets Tab

The last tab is the Network Phidgets tab, which displays a complete list of any Phidget SBCs or Wireless VINT Hubs connected to your network.

Phidgetsbc windowscontrolpanel.PNG


Just like the Phidgets tab, you can right-click on any of the column headers for view options:

Phidgetsbc windowscontrolpanel showmore.PNG


You can also double-click on a device to bring up its web interface.

Wireless VINT Hub Firmware Upgrade

If your Wireless VINT Hub has out-of-date firmware, a blue arrow icon (Win update firm.jpg) will appear in its row.

Controlpanel networktab upgrade.png


You can double-click on the entry for information about how to upgrade your device.

Controlpanel networktab upgradescreen.png

macOS

Install

If you haven't already, follow the getting started with macOS guide. There, you will install the Phidget libraries, including the Phidget Control Panel.

Phidgets Tab

After opening the Phidget Control Panel, you will see something similar to this:

macOS Control Panel General


The Phidgets tab will list all Phidgets (and associated objects) that are connected to your machine, as well as the following information:

  • Serial number: allows you to differentiate between similar Phidgets.
  • Channel: allows you to differentiate between similar objects on a Phidget.
  • Version number: corresponds to the firmware version your Phidget is running.

Running Applications

Every Phidget has an example program, double-click on a Phidget to run the program:

Controlpanel mac openapplication2.png


Note: important features for your device may be missing on the macOS version of the Phidget Control Panel. We recommend using the Windows version of the Phidget Control Panel when possible.

Upgrading 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 the option to apply the update.

Controlpanel mac firmwareupgrade.png

Simply click Upgrade to complete.

Controlpanel mac upgradescreen.png

Downgrading Firmware

This functionality is not supported in the macOS version of the Phidget Control Panel.

Graphing and Data Logging

This functionality is not supported in the macOS version of the Phidget Control Panel.

Error Logging

The Phidget Control Panel keeps a log file of all errors, warnings, and other 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. To view the log file, open the Console application under Applications > Utilities

Controlpanel mac console.png


After opening the Console application, navigate to user logs (~/Library/Logs) on the left menu. You will likely have a list of logs from various applications. After finding the Phidget logs, you will see something like this:

Controlpanel mac log.png

Setting VINT Speed

This functionality is not supported in the macOS version of the Phidget Control Panel.

Setting a Label

This functionality is not supported in the macOS version of the Phidget Control Panel.

Set Hub Port Power

This functionality is not supported in the macOS version of the Phidget Control Panel.

View Device/Channel Properties

This functionality is not supported in the macOS version of the Phidget Control Panel.

Access Device-Specific Options

This functionality is not supported in the macOS version of the Phidget Control Panel.

Network Server Tab

To get started, click on the Network Server tab:

Macos networkserver.png


Settings

  • Start Network Server: start or stop the Network Server. The text to the right of the button will display the current status of the Network Server.
  • Start Automatically on Boot: the Network Server will start automatically when the computer boots. Otherwise, you'll have to manually start the Network Server every time you want to use it.


Phidget Server Settings

  • Enabled: enable the Phidget server. When you enable the Phidget Server, other computers on the network will be able to access the Phidgets that are connected to your computer.
  • Publish: enable/disable mDNS. See the connecting to a Phidget Network Server for more information.
  • Server Name: your server name will allow you to identify your Phidget Server from others on the network.
  • Password (optional): prevent unauthorized computers on the network from accessing the Phidgets connected to your computer by setting a password.
  • Port: The port used by the Phidget Network Server (defaults to 5661).


Webserver Settings

  • Enabled: enable the Webserver. The Webserver allows you to host a webpage that will have access to Phidgets through languages like JavaScript.
  • Docroot: specifies the docroot path. This is where your webpage files will live and any/all additional libraries.
  • Port: The port used by the Webserver (defaults to 8989).


Dictionaries Settings

  • Enable User Dictionaries: in order to create/use a Phidget Dictionary with the Phidget Control Panel, make sure this setting is enabled.
  • Enable Monitoring/control Dictionary: by enabling this setting, you can view incoming/outgoing traffic related to your Phidget Network Server. Currently, you can view this information on a Windows machine only.

Adding a Phidget Dictionary

Phidget Dictionaries are an extremely powerful tool when working with Phidgets. See the Phidget Dictionary page for more information.


Creating a Phidget Dictionary is quick and easy with the Phidget Control Panel. Simply press the + button and specify a name and serial number for your Dictionary:

Controlpanel macos createdictionary.png


Next, make sure your Dictionary is enabled and then start your Phidget Network Server (or Restart, if it is already running). Navigate to the Phidgets tab and you will see your new Dictionary:

Contorlpanel macos dictionary.png


You can now access the Phidget Dictionary from any machine on the network.

Network Phidgets Tab

The last tab is the Network Phidgets tab, which displays a complete list of any Phidget SBC or Wireless VINT Hub connected to your network.

Phidgetsbc maccontrolpanel.png


You can also double-click on a device to bring up its web interface.

Retrieved from "https://www.phidgets.com/docs/index.php?title=Phidget_Control_Panel&oldid=33982"