HUB0000 User Guide: Difference between revisions
No edit summary |
|||
(14 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
<metadesc>The core of our product line, the USB VINT Hub has 6 VINT ports allowing for endless possibilities for USB sensing and control.</metadesc> | <metadesc>The core of our product line, the USB VINT Hub has 6 VINT ports allowing for endless possibilities for USB sensing and control.</metadesc> | ||
[[Category:UserGuide]] | [[Category:UserGuide]] | ||
== | ==Part 1: Setup== | ||
<div class="phd-deck-sequence"> | |||
{{PT1_HUB0000_CHOOSE}} | |||
{{PT1_HUB0000_WIN}} {{PT1_HUB0000_MAC}} {{PT1_HUB0000_LNX}} | |||
</div> | |||
== Part 2: Using Your Phidget == | |||
== | ===About=== | ||
The VINT Hub provides a stable interface to connect your devices to your computer via USB. The VINT Hub has 6 ports. Each port can: | |||
* Connect to a VINT Device | |||
* Read a 0-5V Voltage or ratiometric sensor (connect to Analog Input sensors) | |||
* Act as a digital output (control LEDs, relays, digital circuits, and other simple electronics) | |||
* Act as a digital input (read the state of a switch) | |||
===Explore Your Phidget Channels Using the Control Panel=== | |||
[[ | [[Image:HUB0000-panel.jpg|link=|center]] | ||
The VINT Hub is a connecting point between your computer and device allowing for simple communication. You can use your Control Panel to view your attached Phidgets. Explore the 5 types of connections bellow: | |||
{{UGC-Start}} | |||
{{UGC-Entry|Intelligent VINT Devices| | |||
| | | | ||
[[ | [[Image:vint-v.jpg|350px|link=]] | ||
VINT Devices like the TMP1101 or DCC1003 are Phidgets that digitally communicate with the VINT Hub. Each device will have unique features, so it is recommended you visit the individual product page for more details. | |||
When attached correctly these Phidgets will appear by name in your Control Panel, with each channel listed below the name. For example, when the HUM1000 is attached you will see: | |||
[[ | [[Image:HUM1000_Panel.jpg|link=|center]] | ||
}} | |||
{{UGC-Entry|Digital Input:| read the state of a switch | |||
| | | | ||
[[ | [[Image:vint-di.jpg|350px|link=]] | ||
'''Digital Input''' is one of the VINT Hub’s built-in Channel Classes. Any of the these ports can act as an active-low digital input, making them useful for reading switches and buttons. The above image provides an example of how to wire a switch to be used with the VINT Hub. | |||
If you open '''Digital Input Mode''' in the Control Panel you will be able to see the state of your button/switch. | |||
[[Image:HUB0000-di.jpg|link=]] | |||
}} | |||
{{UGC-Entry| Digital Output:| control LEDs, relays, digital circuits, and other simple electronics | |||
{ | |||
| | |||
| | | | ||
[[Image:vint-do.jpg|350px|link=]] | |||
[[Image: | |||
'''Digital Output''' is one of the VINT Hub’s built-in Channel Classes. Any of these ports can be used as a 3.3V digital output, making them useful for blinking LEDs. The above image demonstrates how to connect your LED to be used with the VINT Hub. | |||
Open '''Digital Output Mode''' in the Control Panel to control the 3.3V output. | |||
[[Image:HUB0000-do.jpg|850px|link=]] | |||
}} | |||
{ | {{UGC-Entry| Voltage Input:| Non-ratiometric Analog sensors and monitoring 5V digital circuits | ||
| | |||
| | | | ||
= | [[Image:vint-vi.jpg|350px|link=]] | ||
'''Voltage Input''' is one of the VINT Hub’s built-in Channel Classes. Any of these ports can be used to read voltage, making them great for reading non-ratiometric sensors and monitoring 5V digital circuits. | |||
Open '''Voltage Input Mode''' in the Control Panel to view your device’s output voltage. | |||
[[Image:HUB0000-vi.jpg|850px|link=]] | |||
[[Image: | }} | ||
{{UGC-Entry| Voltage Ratio Input:| Analog ratiometric sensors | |||
{ | |||
| | |||
| | | | ||
= | [[Image:vint-vr.jpg|350px|link=]] | ||
'''Voltage Ratio Input''' is one of the VINT Hub’s built-in Channel Classes. Any of these ports can act as a Voltage Ratio Input comparing the voltage provided to the voltage returned by the device, making it useful for connecting ratiometric sensors. The voltage ratio is reported in Volts per Volt. For example, if the Phidget is providing 5V and the sensor is sending back 2.5V, the ratio will be 0.5V/V. | |||
Open '''Voltage Ratio Input Mode''' in the Control Panel to view your device’s voltage ratio. | |||
[[Image:HUB0000-vr.jpg|850px|link=]] | |||
}} | |||
[[Image: | |||
{{ | {{UGC-End}} | ||
{{UG-Part3}} | |||
== Part 4: Advanced Topics and Troubleshooting == | |||
{{UGC-Start}} | |||
{{UGC-Addressing}} | |||
{ | {{UGC-Graphing}} | ||
| | {{UGC-DataInterval}} | ||
{{UGC-Firmware}} | |||
{{UGC-NonPhidgetSensor}} | |||
{{UGC-Entry|VINT Ports| | |||
| | | | ||
For more information on the capabilities of the ports on the VINT Hub, see the [[What_is_VINT%3F|VINT Guide]].}} | |||
{{UGC-Entry|Setting the Device Label| | |||
{ | |||
| | |||
| | | | ||
When opening channels with Phidgets, you can set several properties to make sure you are accessing the precise channel you want. The HUB0000 has a unique serial number that can be used to find its ports or any VINT devices connected to them. If you want something more customizable and human-readable, you can use the [[Addressing_Phidgets#Label|device label]] instead. You can customize the device label by using {{code|writeDeviceLabel}} on the {{code|Hub}} object after it has been opened. | |||
With the device label, you can address any of the VINT Hub's channels, or any connected VINT device channels. The device label will remain after the VINT Hub is unplugged as it is stored in flash memory.}} | |||
{{UGC-PortPower}} | |||
{{UGC-End}} | |||
{{ | |||
{{ | |||
Latest revision as of 22:03, 20 July 2023
Part 1: Setup
Part 2: Using Your Phidget
About
The VINT Hub provides a stable interface to connect your devices to your computer via USB. The VINT Hub has 6 ports. Each port can:
- Connect to a VINT Device
- Read a 0-5V Voltage or ratiometric sensor (connect to Analog Input sensors)
- Act as a digital output (control LEDs, relays, digital circuits, and other simple electronics)
- Act as a digital input (read the state of a switch)
Explore Your Phidget Channels Using the Control Panel
The VINT Hub is a connecting point between your computer and device allowing for simple communication. You can use your Control Panel to view your attached Phidgets. Explore the 5 types of connections bellow:
VINT Devices like the TMP1101 or DCC1003 are Phidgets that digitally communicate with the VINT Hub. Each device will have unique features, so it is recommended you visit the individual product page for more details.
When attached correctly these Phidgets will appear by name in your Control Panel, with each channel listed below the name. For example, when the HUM1000 is attached you will see:
Digital Input is one of the VINT Hub’s built-in Channel Classes. Any of the these ports can act as an active-low digital input, making them useful for reading switches and buttons. The above image provides an example of how to wire a switch to be used with the VINT Hub.
If you open Digital Input Mode in the Control Panel you will be able to see the state of your button/switch.
Digital Output is one of the VINT Hub’s built-in Channel Classes. Any of these ports can be used as a 3.3V digital output, making them useful for blinking LEDs. The above image demonstrates how to connect your LED to be used with the VINT Hub.
Open Digital Output Mode in the Control Panel to control the 3.3V output.
Voltage Input is one of the VINT Hub’s built-in Channel Classes. Any of these ports can be used to read voltage, making them great for reading non-ratiometric sensors and monitoring 5V digital circuits.
Open Voltage Input Mode in the Control Panel to view your device’s output voltage.
Voltage Ratio Input is one of the VINT Hub’s built-in Channel Classes. Any of these ports can act as a Voltage Ratio Input comparing the voltage provided to the voltage returned by the device, making it useful for connecting ratiometric sensors. The voltage ratio is reported in Volts per Volt. For example, if the Phidget is providing 5V and the sensor is sending back 2.5V, the ratio will be 0.5V/V.
Open Voltage Ratio Input Mode in the Control Panel to view your device’s voltage ratio.
Part 3: Create your Program
Part 4: Advanced Topics and Troubleshooting
Before you open a Phidget channel in your program, you can set these properties to specify which channel to open. You can find this information through the Control Panel.
1. Open the Control Panel and double-click on the red map pin icon:
2. The Addressing Information window will open. Here you will find all the information you need to address your Phidget in your program.
See the Phidget22 API for your language to determine exact syntax for each property.
Note: Graphing and logging is currently only supported in the Windows version of the Phidget Control Panel.
In the Phidget Control Panel, open the channel for your device and click on the icon next to the data type that you want to plot. This will open up a new window:
If you need more complex functionality such as logging multiple sensors to the same sheet or performing calculations on the data, you'll need to write your own program. Generally this will involve addressing the correct channel, opening it, and then creating an Event Handler and adding graphing/logging code to it.
The quickest way to get started is to download some sample code for your desired programming language and then search google for logging or plotting in that language (e.g. "how to log to csv in python") and add the code to the existing change handler.
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.
The Change Trigger is the minimum change in the sensor data needed to trigger a new data event.
The Data Interval is the time (in ms) between data events sent out from your Phidget.
The Data Rate is the reciprocal of Data Interval (measured in Hz), and setting it will set the reciprocal value for Data Interval and vice-versa.
You can modify one or both of these values to achieve different data outputs. You can learn more about these properties here.
Firmware Upgrade
MacOS users can upgrade device firmware by double-clicking the device row in the Phidget Control Panel.
Linux users can upgrade via the phidget22admin tool (see included readme for instructions).
Windows users can upgrade the firmware for this device using the Phidget Control Panel as shown below.
Firmware Downgrade
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 (for instance, when an application you're using is compiled using an older version of phidget22 that doesn't recognize the new firmware).
MacOS and Linux users can downgrade using the phidget22admin tool in the terminal (see included readme for instructions).
Windows users can downgrade directly from the Phidget Control Panel if they have driver version 1.9.20220112 or newer:
Firmware Version Numbering Schema
Phidgets device firmware is represented by a 3-digit number. For firmware patch notes, see the device history section on the Specifications tab on your device's product page.
- If the digit in the 'ones' spot changes, it means there have been bug fixes or optimizations. Sometimes these changes can drastically improve the performance of the device, so you should still upgrade whenever possible. These upgrades are backwards compatible, meaning you can still use this Phidget on a computer that has Phidget22 drivers from before this firmware upgrade was released.
- If the digit in the 'tens' spot changes, it means some features were added (e.g. new API commands or events). These upgrades are also backwards compatible, in the sense that computers running old Phidget22 drivers will still be able to use the device, but they will not be able to use any of the new features this version added.
- If the digit in the 'hundreds' spot changes, it means a major change has occurred (e.g. a complete rewrite of the firmware or moving to a new architecture). These changes are not backwards compatible, so if you try to use the upgraded board on a computer with old Phidget22 drivers, it will show up as unsupported in the Control Panel and any applications build using the old libraries won't recognize it either. Sometimes, when a Phidget has a new hardware revision (e.g. 1018_2 -> 1018_3), the firmware version's hundreds digit will change because entirely new firmware was needed (usually because a change in the processor). In this case, older hardware revisions won't be able to be upgraded to the higher version number and instead continue to get bug fixes within the same major revision.
If the sensor requires 5V DC power and outputs a 0-5V signal, you can connect it directly to a VINT Port. The easiest way to connect it is to cut the end off of a Phidget Cable and solder the bare wires to the appropriate pins:
- Black: Ground
- Red: 5V Power
- White: 0-5V Analog Signal
You should check the sensor's datasheet to determine if it is Ratiometric or Non-Ratiometric. Ratiometric sensors output a voltage proportional to the voltage on the 5V power line, so they're more resilient against noise and power fluctuations. Non-Ratiometric sensors have their own 5V regulator, and always output a voltage relative to that 5V reference point. You need to use the appropriate channel class when opening the sensor (i.e. the VoltageRatioInput class or the VoltageInput class), or else your sensor readings will be inaccurate.
You can tell a sensor is ratiometric if the output in the datasheet is specified in units of volts-per-volt (V/V) or in terms of its supply voltage ("Vcc"):
This specification says the sensor outputs a voltage value of Vcc/512 for each inch of measurement, so it must be ratiometric.
If the sensor outputs a 0-5V signal, but requires 12-24V DC power, the VINT Hub cannot provide the correct voltage by itself. You can use a DAQ1400, and then connect that to one of the ports on your VINT Hub. See the DAQ1400 product page and User Guide for details.
An NPN sensor with a power requirement of 5V DC can be connected directly to a port on your VINT Hub:
- Black: Connect to sensor ground
- Red: Connect to sensor power
- White: Connect to sensor output
The easiest way to connect it is to snip the end off of a Phidget Cable and solder the wires to the sensor's wires.
A PNP sensor cannot be connected directly to a VINT Hub, because the digital inputs are active low. You'd need to use a pull-down resistor between the white and black wires of the Phidget cable that leads to the sensor in order for it to work.
Digital sensors that require 12V or 24V DC power can be used with the DAQ1400. See the DAQ1400 product page and User Guide for details.
Sensors with a 4-20mA output can also be interfaced with the DAQ1400. See the DAQ1400 product page and User Guide for details.
Sensors that use serial, I2C, or other digital communication protocols cannot easily be used with Phidgets. You should check the datasheet and pinout to see if they have an analog or 4-20mA output feature available.
For more information on the capabilities of the ports on the VINT Hub, see the VINT Guide.
When opening channels with Phidgets, you can set several properties to make sure you are accessing the precise channel you want. The HUB0000 has a unique serial number that can be used to find its ports or any VINT devices connected to them. If you want something more customizable and human-readable, you can use the device label instead. You can customize the device label by using writeDeviceLabel
on the Hub
object after it has been opened.
With the device label, you can address any of the VINT Hub's channels, or any connected VINT device channels. The device label will remain after the VINT Hub is unplugged as it is stored in flash memory.
Many VINT devices have power-saving automatically built-in, but you also have the ability to turn off the VINT ports entirely if they're not in use. The ports can be enabled and disabled in groups of three (Ports 0-1-2 and Ports 3-4-5). This is because those ports share the same power supply. You can toggle the port power using the PortPower property of the Hub object. For more details and a code snippet, visit the Phidget22 API page and select your language, device, and then USB and Hub API for the final two menus.