HUB0000 User Guide: Difference between revisions

From Phidgets Support
No edit summary
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]]
==Getting Started==
==Part 1: Setup==
Before you get started with plugging in and setting up your VINT Hub, we recommend downloading our libraries from [[Operating_System_Support|here]].
Before you get started with plugging in and setting up your VINT Hub, we recommend downloading our libraries from [[Operating_System_Support|here]].


{{UGcontrolpanel|HUB0000}}
{{UGcontrolpanel|HUB0000}}


==Using the HUB0000==
== Part 2: Using Your Phidget ==


This table will help you decide where to look next to get your devices plugged in and running:
===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:


{|style="color: black; width: 100%; text-align:center; border-style: solid; border-width: 2px;" cellpadding="10"
* Connect to a VINT Device
|- valign="top"
* Read a 0-5V Voltage or ratiometric sensor (connect to Analog Input sensors)
|style="text-align:center;" colspan="2" |
* 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)


[[#VINT Device| VINT Device Mode]]
===Explore Your Phidget Channels Using the Control Panel===


[[Image:vint-v.jpg|350px|link=#VINT Device]]
[[Image:HUB0000-panel.jpg|link=|center]]


This mode is for connecting to a VINT device. These devices differ from analog sensors because instead of just reporting 0 to 5 volts, they communicate with the VINT Hub. The communication is digital, therefore it is immune to electrical interference between the hub and the device.
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:
|-
|
[[#Digital Input | Digital Input Mode]]


[[Image:vint-di.jpg|280px|link=#Digital Input]]
{{UGC-Start}}
 
In digital input mode, the VINT Hub port can act as an active-low digital input. This mode is great for reading the state of buttons and switches.


{{UGC-Entry|Intelligent VINT Devices|
|
|
[[#Voltage Ratio Input | Voltage Ratio Input Mode]]
[[Image:vint-v.jpg|350px|link=]]
 
[[Image:vint-vr.jpg|280px|link=#Voltage Ratio Input]]


In voltage ratio input mode, the VINT Hub port will read the voltage on the white wire and compare it to the voltage being supplied on the red wire. This mode will let you read any ratiometric Phidgets sensor.
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.
|-
|


[[#Voltage Input | Voltage Input Mode]]
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:vint-vi.jpg|280px|link=#Voltage Input]]
[[Image:HUM1000_Panel.jpg|link=|center]]
}}


In voltage input mode, the VINT Hub port will read the voltage on the white wire. This can be used to interface a non-ratiometric sensor, or to measure the voltage in a 5V digital circuit.
{{UGC-Entry|Digital Input:| read the state of a switch
|
|
[[#Digital Output | Digital Output Mode]]
[[Image:vint-di.jpg|350px|link=]]


[[Image:vint-do.jpg|280px|link=#Digital Output]]
'''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.


In digital output mode, a VINT Hub port can behave like a 3.3V digital output. You could use this mode to blink an LED or switch on a MOSFET. And don't worry if you still need a 5V digital output; there are VINT modules available that provide multiple 5V digital outputs on a single VINT port.
If you open '''Digital Input Mode''' in the Control Panel you will be able to see the state of your button/switch.
|}


{{UGIntroDone|HUB0000}}
[[Image:HUB0000-di.jpg|link=]]
}}


 
{{UGC-Entry| Digital Output:| control LEDs, relays, digital circuits, and other simple electronics
 
{|style="color: black; width: 100%; border-style: solid; border-width: 2px;" cellpadding="10"
| style="width: 5%;"|  
|
|
===VINT Device===
[[Image:vint-do.jpg|350px|link=]]
[[Image:HIN1101_Functional.jpeg|300px|right|link=]]
A VINT Device is any Phidget that must be controlled by a VINT Hub instead of plugging directly into your computer via USB. You can find a complete list of VINT devices {{CT|VINTDevice|here}}.


When you double click on an VINT Device in the control panel, a window will open with controls and readouts for that specific class of Phidget. For instructions on how to use this example, find the '''[[:Category:UserGuide|user guide]]''' for that Phidget.
'''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.
<br clear="all">
|}


Open '''Digital Output Mode''' in the Control Panel to control the 3.3V output.


[[Image:HUB0000-do.jpg|850px|link=]]
}}


{|style="color: black; width: 100%; border-style: solid; border-width: 2px;" cellpadding="10"
{{UGC-Entry| Voltage Input:| Non-ratiometric Analog sensors and monitoring 5V digital circuits
| style="width: 5%;"|  
|
|
===Digital Input===
[[Image:vint-vi.jpg|350px|link=]]
 
====Using the Digital Inputs====
Here are some circuit diagrams that illustrate how to connect various devices to the digital inputs on your Phidget.
 
=====Wiring a switch to a Digital Input=====
[[Image:vint-di.jpg|300px|right|link=|]]
Connect the switch between the white and black wires of a Phidget cable, and plug the cable into a VINT port. Wiring the switch this way will make the input TRUE when the switch is closed, and FALSE when the switch is open.
<br clear="all">
====Using the Control Panel====
 
Double-click on a Digital Input object in order to run the example:
[[Image:HUB0000_DigitalInput_Example.jpg|center|link=]]
 
 
{{UGExampleDescription}}
*{{UGDigitalInputActiveLow}}
 
For more information about Digital Inputs, take a look at the [[Digital Input Primer]]


{{UgAddressing}}
'''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=]]
}}


{|style="color: black; width: 100%; border-style: solid; border-width: 2px;" cellpadding="10"
{{UGC-Entry| Voltage Ratio Input:| Analog ratiometric sensors
| style="width: 5%;"|  
|
|
[[Image:vint-vr.jpg|350px|link=]]


===Digital Output===
'''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.
====Using the Digital Outputs====
Here are some diagrams that illustrate how to connect various devices to the digital outputs on your Phidget.
 
=====Driving an LED=====
 
[[Image:vint-do.jpg|link=|300px|right|Diagram for connecting to an LED.]]
Connecting an LED to a digital output is simple. Wire the anode (long side) to the white wire on the Phidget cable, and the cathode to the black wire of the Phidget cable. If you wire it backwards, the LED will not light but no harm will come to the system.
<br clear="all">
 
====Using the Control Panel====
Double-click on a Digital Output object in order to run the example:
[[Image:HUB0000_DigitalOutput_Example.jpg|center|link=]]


{{UGExampleDescription}}
Open '''Voltage Ratio Input Mode''' in the Control Panel to view your device’s voltage ratio.
*Toggle the state of the digital output by pressing the button.
*{{UGDigitalOutputDutyCycleDescription}}


For more information about Digital Outputs, check out the [[Digital Output Primer]].
[[Image:HUB0000-vr.jpg|850px|link=]]
}}


{{UgAddressing}}
{{UGC-End}}
|}


{{UG-Part3}}


== Part 4: Advanced Topics and Troubleshooting ==


{|style="color: black; width: 100%; border-style: solid; border-width: 2px;" cellpadding="10"
{{UGC-Start}}
| style="width: 5%;"|  
{{UGC-Addressing}}
{{UGC-DataInterval}}
{{UGC-Entry|VINT Ports|
|
|
 
For more information on the capabilities of the ports on the VINT Hub, see the [[What_is_VINT%3F|VINT Primer]].}}
===Voltage Input===
{{UGC-Entry|Setting the Device Label|
====Using the Voltage Inputs====
 
Here are some examples of how you can connect various devices to the voltage inputs on your Phidget:
 
[[Image:Sensor_Voltage_Input.jpg|right|link=|400px|Diagram for connecting to a Phidget sensor]]
=====Connect a Sensor=====
Connecting to a Phidget sensor is as simple as plugging it into the [[What is VINT?|VINT Port]] with a Phidget cable.
<br clear="all">
 
====Using the Control Panel====
 
Double-click on a Voltage Input object in order to run the example:
[[Image:HUB0000_VoltageInputSensor_Example.jpg|center|link=]]
 
 
{{UGExampleDescription}}
*Modify the change trigger and/or data interval value by dragging the sliders. For more information on these settings, see the [[Data_Rate_and_Change_Trigger|data interval/change trigger]] page.
*If you have an analog sensor connected that you bought from us, you can select it from the ''Sensor Type'' drop-down menu. The example will then convert the voltage into a more meaningful value based on your sensor, with units included, and display it beside the ''Sensor Value'' label. Converting voltage to a ''Sensor Value'' is not specific to this example, it is handled by the Phidget libraries, with functions you have access to when you begin developing!
<br clear="all">
 
For more information about Voltage Inputs, check out the [[Voltage Input Primer]].
 
{{UgAddressing}}
|}
 
 
 
{|style="color: black; width: 100%; border-style: solid; border-width: 2px;" cellpadding="10"
| style="width: 5%;"|  
|
|
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.


===Voltage Ratio Input===
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.}}
====Using the Voltage Ratio Inputs====
 
Here are some examples of how you can connect various devices to the voltage ratio inputs on your Phidget:
 
[[Image:Sensor_Voltage_Ratio_Input.jpg|right|link=|400px|Diagram for connecting to a Phidget sensor]]
=====Connect a Sensor=====
Connecting to a ratiometric sensor is as simple as plugging it into the [[What is VINT?|VINT Port]] with a Phidget cable.
<br clear="all">
 
====Using the Control Panel====
Double-click on a Voltage Ratio Input object in order to run the example:
[[Image:HUB0000_VoltageRatioSensor_Example.jpg|link=|center]]
 
{{UGExampleDescription}}
*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.
*Modify the change trigger and/or data interval value by dragging the sliders. For more information on these settings, see the [[Data_Rate_and_Change_Trigger|data interval/change trigger]] page.
*If you have an analog sensor connected that you bought from us, you can select it from the Sensor Type drop-down menu. The example will then convert the voltage into a more meaningful value based on your sensor, with units included, and display it beside the Sensor Value label. Converting voltage to a Sensor Value is not specific to this example, it is handled by the Phidget libraries, with functions you have access to when you begin developing!
<br clear="all">
 
For more information about Voltage Ratio Inputs, check out the [[Voltage Ratio Input Primer]].
 
{{UgAddressing}}
|}
 
 
 
{{ugAddressingInformation}}
 
{{ugUsingYourOwnProgram|HUB0000}}
 
==Technical Details==
 
===VINT Ports===
 
For more information on the capabilities of the ports on the VINT Hub, see the [[What_is_VINT%3F|VINT Primer]].
 
===Setting the Device Label===
 
When opening channels with Phidgets, you can set a number of properties to make sure you match the precise channel you want. The HUB0000 has a unique serial number which 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 [[Using_Multiple_Phidgets#Using_the_Label|device label]] instead. You can customize the device label by using {{Code|writeDeviceLabel}} on the {{Code|Hub}} object after it's been opened.
 
Once a device label has been written, you can use it to address any of the VINT Hub's channels, or the channels of any VINT device connected to the hub.  




{{UGnext|}}
{{UGC-End}}

Revision as of 18:28, 21 April 2020


Part 1: Setup

Before you get started with plugging in and setting up your VINT Hub, we recommend downloading our libraries from here.

Phidget Control Panel

In order to demonstrate the functionality of the HUB0000, the Phidget Control Panel running on a Windows machine will be used.


The Phidget Control Panel is available for use on both macOS and Windows machines.

Windows

To open the Phidget Control Panel on Windows, find the Ph.jpg icon in the taskbar. If it is not there, open up the start menu and search for Phidget Control Panel

Windows PhidgetTaskbar.PNG

macOS

To open the Phidget Control Panel on macOS, open Finder and navigate to the Phidget Control Panel in the Applications list. Double click on the Ph.jpg icon to bring up the Phidget Control Panel.


For more information, take a look at the getting started guide for your operating system:


Linux users can follow the getting started with Linux guide and continue reading here for more information about the HUB0000.

First Look

After plugging the HUB0000 into your computer and opening the Phidget Control Panel, you will see something like this:

HUB0000 Panel.jpg


The Phidget Control Panel will list all connected Phidgets and associated objects, 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. If your Phidget is listed in red, your firmware is out of date. Update the firmware by double-clicking the entry.


The Phidget Control Panel can also be used to test your device. Double-clicking on an object will open an example.

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

HUB0000-panel.jpg

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:

Expand All
Intelligent VINT Devices

Vint-v.jpg

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:

HUM1000 Panel.jpg
Digital Input: read the state of a switch

Vint-di.jpg

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.

HUB0000-di.jpg

Digital Output: control LEDs, relays, digital circuits, and other simple electronics

Vint-do.jpg

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.

HUB0000-do.jpg

Voltage Input: Non-ratiometric Analog sensors and monitoring 5V digital circuits

Vint-vi.jpg

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.

HUB0000-vi.jpg

Voltage Ratio Input: Analog ratiometric sensors

Vint-vr.jpg

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.

HUB0000-vr.jpg

Part 3: Create your Program

Part 4: Advanced Topics and Troubleshooting

Expand All
How do I know what channel, serial number, or hub port to use in my program?

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:

The locate Phidget button is found in the device information box

2. The Addressing Information window will open. Here you will find all the information you need to address your Phidget in your program.

All the information you need to address your Phidget


See the Phidget22 API for your language to determine exact syntax for each property.

Setting the Change Trigger and Data Interval

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.

VINT Ports

For more information on the capabilities of the ports on the VINT Hub, see the VINT Primer.

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


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