Phidget Control Panel: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Overview]]
[[Category:Overview]]
==Getting Started with the Phidget Control Panel==
==Getting Started==
The Phidget Control Panel is a powerful tool that will help you develop your Phidgets applications. With the Phidget Control Panel, you can see any/all Phidgets that are attached to your machine (or a remote machine), update your Phidget's firmware, manage a Phidget Network Server, and more!
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!  




If you are using a Windows machine, keep reading. If you are using a macOS machine, jump ahead to the [[#macOS|macOS section]].
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==
If you haven't already, follow the [[OS_-_Windows#Getting started with Windows|getting started with Windows]] section on the Windows OS page. There you will install the Phidget libraries and learn how to open the Phidget Control Panel.
===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]]




Next, open the Phidget Control Panel and keep reading!
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).


===Phidgets tab===
After opening the Phidget Control Panel, you should see something like this:
[[File:Windows ControlPanel General.PNG|link=|alt=Windows Control Panel General|center]]


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


The Phidgets tab will list all Phidgets (and associated objects) that are connected to your machine, as well as the following information:
[[Image:ControlpanelFWdown.jpg|link=]]
*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.




Double-click on a Phidget device to run an example program:
You can then select a specific firmware version.
[[File:RFIDReadWrite_Example.jpg|link=|alt=Windows Control Panel Example|center]]


[[Image:Controlpanel_firmwaredowngradescreen.png|link=|center]]


The screenshot above shows the example application for the 1024 - PhidgetRFID Read-Write. These examples are intended for demonstration and debugging purposes.
==== 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:


====Setting a label====
[[Image:plot2.jpg|link=|850px]]
Right-click on a Phidget to set a label. See [[setting a label]] for more information about how to use labels with Phidgets.
[[File:Controlpanel_windows_setlabel.png|link=|center]]


===== 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.


====Updating Firmware====
===== Graph Type =====
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.
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.


====Logging====
====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 enable logging, first navigate to ''File'' -> ''Options...''
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]]
[[File:Controlpanel_windows_fileoptions.png|link=|center]]




Next, check the box beside ''Enable Logging''. From the ''Level'' drop-down menu, you can select how detailed you want the output to be:
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.
*Info: default/recommended setting. Will log general information such as errors, attach/detach events, etc.
*Error/Warning: will only log error messages/warning messages. Useful for keeping log files small in size.
*Debug: for use with Debug version of library.
*Critical: will only log critical messages (e.g. if program crashes)
*Verbose: will log everything. Not recommended for normal use.
[[File:Windows_ControlPanel_NetworkService_LogLevel.PNG|link=|alt=Windows Control Panel Network Server Setup|center]]
[[File:Windows_ControlPanel_NetworkService_LogLevel.PNG|link=|alt=Windows Control Panel Network Server Setup|center]]




To view the log files, click on ''Logs'' in the bottom right corner of the Phidget Control Panel. You can also find it by navigating to the following location:
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
*C:/ProgramData/Phidgets/logs




Line 58: Line 83:




There is a separate log file for each example, as well as the Network Server, to make it easier to find messages that are relevant to the part you're debugging.
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]]


===Network Server tab===
====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:
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]]
[[File:Windows_ControlPanel_NetworkService_Setup_Stopped.jpg|link=|center|alt=Windows Control Panel Network Server Setup]]




There are quite a few settings here, so we will go through them one at a time:
====Settings====
 
''Settings''
*'''Startup Type:''' determines when the Phidget Network Server will start.  
*'''Startup Type:''' determines when the Phidget Network Server will start.  
**'''Automatic:''' the Phidget Network Server will start automatically when Windows boots.  
**'''Automatic:''' the Phidget Network Server will start automatically when Windows boots.  
Line 73: Line 125:
**'''Disabled:''' mode means the Phidget Network Server will stay off, regardless of what tries to start 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 computer on the network will be able to access the Phidgets that are connected to your computer.
====Phidget Server Settings====
*'''Publish:''' WAITING ON INFO FOR THIS PART (LUCAS)
*'''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.
*'''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.
*'''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|logging]] section above for more information.
*'''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).
*'''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 the Phidgets through languages like [[Language_-_JavaScript|JavaScript]].
====Webserver Settings====
*'''Docroot:'' specifies the docroot path.  
*'''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).
*'''Port:''' The port used by the Webserver (defaults to 8989).


''Dictionaries Settings''
 
====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 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:
*'''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]]
[[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.
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:
[[File:Controlpanel_windows_createdictionary.png|link=|center]]




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]]


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


[[File:Windows ControlPanel NetworkService PhidgetSBC.jpg|link=|alt=Windows Control Panel Network Server PhidgetSBC]]
You can now access the Phidget Dictionary from any machine on the network.


You can double click on the PhidgetSBC to bring up the PhidgetSBC Administration Console log-in page in your default browser.
===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]]


[[File:PhidgetSBCAdminConsole.PNG|link=|alt=PhidgetSBC Admin Console]]


The PhidgetSBC Administration Console is where you can go to configure the PhidgetSBC. For more details, please see the [[:Category:UserGuide | User Guide]] for your SBC.
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]]
 
 
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 ([[File:Win_update_firm.jpg]]) will appear in its row.
[[File:Controlpanel_networktab_upgrade.png|link=|center]]
 
 
You can double-click on the entry for information about how to upgrade your device.
[[File:Controlpanel_networktab_upgradescreen.png|link=|center]]


==macOS==
==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.
===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]]
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:
[[File:Controlpanel_mac_openapplication2.png|link=https://www.phidgets.com/docs/images/1/11/Controlpanel_mac_openapplication2.png|center|600px]]
'''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.
[[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|Finder}} and find the Phidget Control Panel in the Applications list.
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 Finder Apps.png|link=|900px|alt=macOS Finder Apps]]
====Downgrading Firmware====
This functionality is not supported in the macOS version of the Phidget Control Panel.


Double click on the {{Code|Phidgets}} icon to bring up 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''
[[File:Controlpanel_mac_console.png|600px|link=|center]]


===Phidgets Tab===


[[File:OSX ControlPanel General.png|link=|alt=macOS Control Panel General]]
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]]


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.
====Setting VINT Speed====
This functionality is not supported in the macOS version of the Phidget Control Panel.


[[File:OSX Control Panel Channel.png ‎|link=|alt=macOS Control Panel Channel]]
====Setting a Label====
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 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) before 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 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.
====Access Device-Specific Options====
This functionality is not supported in the macOS version of the Phidget Control Panel.


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


The next tab is the {{Code|Network Server}} 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:macOS_ControlPanel_NetworkService_Setup_Stopped.jpg|link=|alt=macOS Control Panel Network Server Setup]]


The settings are as follows:
====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.


'''Start Network Server''': This button will start or stop the Network Server. The text to the right of the button will display the current status of the Network Server.


'''Startup''': By checking the box, 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 [[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).


'''Phidget Server Enabled''': Check this box to enable the Phidget server, which is the part of the Network Server that makes the Phidgets connected to this computer accessible to other devices on your network.


'''Server Name''': When other computer's Phidget Control Panel applications see your Phidget Server, this is the name that will be displayed. When writing code, you can also locate remote Phidgets based on the name of the server hosting them.
====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).


'''Port''': The port used by the Phidget network server. Default is 5661.


'''Password''': Optional password that will be required to attach to the Phidgets on this server.
====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.


'''Webserver Enabled''': Check this box to enable the Webserver. The Webserver allows you to host a webpage that will have access to the Phidgets through languages like [[Language_-_JavaScript|JavaScript]]. For more information, have a look at the [[Phidget Network Server]] page.
====Adding a Phidget Dictionary====
Phidget Dictionaries are an extremely powerful tool when working with Phidgets. See the [[Phidget Dictionary]] page for more information.


'''Port''': The port used by the Phidget web server. Default is 8989.


In order to make changes to any of these settings, you'll need administrator privileges.
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]]


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


[[File:macOS Control Panel PhidgetSBC.png|link=|alt=macOS Control Panel 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 [[:Category:UserGuide | User Guide]] for your SBC.
===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 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"