Error Event Code List: Difference between revisions

From Phidgets Support
(Created page with "====Error Event Codes==== This page lists all error event codes with more in-depth descriptions than can be found in the {{Phidget22API}}. These codes are passed to an error...")
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Programming]]
====Error Event Codes====
====Error Event Codes====


Line 5: Line 6:
These codes are passed to an error event handler. See the {{Phidget22API}} documentation for your device to see which error event codes are supported.  The error event codes are generic, and the error description passed to the error event handler may contain more detailed information about the actual cause of the error event.
These codes are passed to an error event handler. See the {{Phidget22API}} documentation for your device to see which error event codes are supported.  The error event codes are generic, and the error description passed to the error event handler may contain more detailed information about the actual cause of the error event.


'''BADVERSION'''
{| class="wikitable"
:Version Mismatch Error. Usually means client and server library versions are out of sync. Update to the latest version of the Phidget software.
! Name !! style="width: 110px;" | Value !! Description !! Details
|-
| BADVERSION  
| Hex: 0x01
Dec: 1
| Version Mismatch  
| Network Client and Server protocol versions don't match.


Ensure that both sides are using the same release of phidget22.
|-
| BUSY
| Hex: 0x02
Dec: 2
| Phidget in Use
| The Phidget device channel has already been locally attached. Only one channel may attach locally to a device channel.
|-
| NETWORK
| Hex: 0x03
Dec: 3
| Network Error
| An error occurred with the network communications.


'''BUSY'''
You can use the <code>getDescription</code> method of the error event to get more information.
:The Phidget device channel has already been locally attached. Only one channel may attach locally to a device channel.
|-
| DISPATCH
| Hex: 0x04
Dec: 4
| Dispatch Error
| An error occurred when trying to dispatch an event.


It's possible that the data rate is too fast for the computer (or network) and the event queue has filled up.
|-
| FAILURE
| Hex: 0x05
Dec: 5
| General Failure
| A general failure occured - see description for details.
|-
| OK
| Hex: 0x1000
Dec: 4096
| Error Cleared
| An error state has ended. You can use the <code>getDescription</code> method of the error event to get more information.
|-
| OVERRUN
| Hex: 0x1002
Dec: 4098
| Sample Overrun
| Sampling overrun.


'''NETWORK'''
Some samples were lost in firmware because the queue filled up. This error is exclusive to Phidget InterfaceKits.
:An error occurred with the network communications. See the error description for more details.
|-
| PACKETLOST
| Hex: 0x1003
Dec: 4099
| Packet Lost
| One or more packets were lost.


This error is often an indication that your event handlers are not executing fast enough. Try to remove slow processes like GUI updates or user input from your handlers.
|-
| WRAP
| Hex: 0x1004
Dec: 4100
| Wrap-Around
| Variable has wrapped around.


'''DISPATCH'''
A variable has wrapped. For example, the encoder position can wrap from 2,147,483,647 to -2,147,483,648 because of an integer overflow.
:An error occurred when trying to dispatch an event. It's possible that the data rate is too fast for the computer (or network) and the event queue has filled up.
|-
| OVERTEMP
| Hex: 0x1005
Dec: 4101
| Over-Temperature
| Over-temperature condition detected. You can use the <code>getDescription</code> method of the error event to get more information.
|-
| OVERCURRENT
| Hex: 0x1006
Dec: 4102
| Over-Current
| Over-current condition detected. You can use the <code>getDescription</code> method of the error event to get more information.
|-
| OUTOFRANGE
| Hex: 0x1007
Dec: 4103
| Out of Range
| Out of range condition detected. You can use the <code>getDescription</code> method of the error event to get more information.
|-
| BADPOWER
| Hex: 0x1008
Dec: 4104
| Bad Power
| Power supply problem detected.  You can use the <code>getDescription</code> method of the error event to get more information.
|-
| SATURATION
| Hex: 0x1009
Dec: 4105
| Saturation
| Saturation condition detected.


A sensor's value has reached the maximum or minimum of its sensing range. For example, a 1000 lux light sensor will throw this error event when a value greater than 1000 lux is detected.
|-
| OVERVOLTAGE
| Hex: 0x100b
Dec: 4107
| Over-Voltage
| Over-voltage condition detected.


'''OK'''
Occurs in power-providing Phidgets when the output voltage exceeds the set value. You can use the <code>getDescription</code> method of the error event to get more information.
: An error state has ended. You can use the <code>getDescription</code> method of the error event to get more information.
|-
| FAILSAFE
| Hex: 0x100c
Dec: 4108
| Failsafe
| Failsafe condition detected.
|-
| VOLTAGEERROR
| Hex: 0x100d
Dec: 4109
| Voltage Error
| Voltage error detected.


'''OVERRUN'''
A voltage error occurs when a Phidget that provides a voltage output has the value drop below what what specified. This can happen if the device being powered draws too much current, which causes a voltage drop. Stay within output current specifications to avoid voltage errors.
:Sampling overrun. Some samples were lost in firmware because the queue filled up. This error is exclusive to Phidget InterfaceKits.  
|-
| ENERGYDUMP
| Hex: 0x100e
Dec: 4110
| Energy Dump
| Energy dump condition detected.


An energy dump occurs when a power-providing Phidget needs to dissipate its extra energy. See the [[Product Page Links|User Guide]] for your device for more information.
|-
| MOTORSTALL
| Hex: 0x100f
Dec: 4111
| Motor Stall
| Motor stall detected.


'''PACKETLOST'''
Occurs when a dangerous motor stall is detected. You can use the <code>getDescription</code> method of the error event to get more information.  
:Packet(s) were lost. This error is often an indication that your event handlers are not executing fast enough. Try to remove slow processes like GUI updates or user input from your handlers.
|}
 
 
'''WRAP'''
:A variable has wrapped. For example, the encoder position can wrap from 2,147,483,647 to -2,147,483,648 because of an integer overflow.
 
 
'''OVERTEMP'''
:Over-Temperature condition detected. See error description for more details.
 
 
'''OVERCURRENT'''
:Over-Current condition detected. See error description for more details.
 
 
'''OUTOFRANGE'''
:Out of range condition detected. Usually an input on the board is reporting a value that is outside of the allowed range.
 
 
'''BADPOWER'''
:Power supply problem detected. Either the power supply is being overloaded, or it is under-powered (possibly not plugged in).
 
 
'''SATURATION'''
:A sensor's value has reached the maximum or minimum of its sensing range. For example, a 1000 lux light sensor will throw this error event when a value greater than 1000 lux is detected. The sensor will still be reporting 1000 lux, but this error tells you that you don't know for certain how much higher than 1000 the real reading is.
 
 
'''OVERVOLTAGE'''
:Over-Voltage condition detected. Occurs in power-providing Phidgets when the output voltage exceeds the set value.
 
 
'''VOLTAGEERROR'''
:A voltage error occurs when a Phidget that provides a voltage output has the value drop below what what specified. This can happen if the device being powered draws too much current, which causes a voltage drop. Stay within output current specifications to avoid voltage errors.
 
 
'''ENERGYDUMP'''
:An energy dump occurs when a power-providing Phidget needs to dissipate its extra energy. See the [[:Category:UserGuide|User Guide]] for your device for more information.

Latest revision as of 18:52, 22 March 2019

Error Event Codes

This page lists all error event codes with more in-depth descriptions than can be found in the Phidget22 API.

These codes are passed to an error event handler. See the Phidget22 API documentation for your device to see which error event codes are supported. The error event codes are generic, and the error description passed to the error event handler may contain more detailed information about the actual cause of the error event.

Name Value Description Details
BADVERSION Hex: 0x01

Dec: 1

Version Mismatch Network Client and Server protocol versions don't match.

Ensure that both sides are using the same release of phidget22.

BUSY Hex: 0x02

Dec: 2

Phidget in Use The Phidget device channel has already been locally attached. Only one channel may attach locally to a device channel.
NETWORK Hex: 0x03

Dec: 3

Network Error An error occurred with the network communications.

You can use the getDescription method of the error event to get more information.

DISPATCH Hex: 0x04

Dec: 4

Dispatch Error An error occurred when trying to dispatch an event.

It's possible that the data rate is too fast for the computer (or network) and the event queue has filled up.

FAILURE Hex: 0x05

Dec: 5

General Failure A general failure occured - see description for details.
OK Hex: 0x1000

Dec: 4096

Error Cleared An error state has ended. You can use the getDescription method of the error event to get more information.
OVERRUN Hex: 0x1002

Dec: 4098

Sample Overrun Sampling overrun.

Some samples were lost in firmware because the queue filled up. This error is exclusive to Phidget InterfaceKits.

PACKETLOST Hex: 0x1003

Dec: 4099

Packet Lost One or more packets were lost.

This error is often an indication that your event handlers are not executing fast enough. Try to remove slow processes like GUI updates or user input from your handlers.

WRAP Hex: 0x1004

Dec: 4100

Wrap-Around Variable has wrapped around.

A variable has wrapped. For example, the encoder position can wrap from 2,147,483,647 to -2,147,483,648 because of an integer overflow.

OVERTEMP Hex: 0x1005

Dec: 4101

Over-Temperature Over-temperature condition detected. You can use the getDescription method of the error event to get more information.
OVERCURRENT Hex: 0x1006

Dec: 4102

Over-Current Over-current condition detected. You can use the getDescription method of the error event to get more information.
OUTOFRANGE Hex: 0x1007

Dec: 4103

Out of Range Out of range condition detected. You can use the getDescription method of the error event to get more information.
BADPOWER Hex: 0x1008

Dec: 4104

Bad Power Power supply problem detected. You can use the getDescription method of the error event to get more information.
SATURATION Hex: 0x1009

Dec: 4105

Saturation Saturation condition detected.

A sensor's value has reached the maximum or minimum of its sensing range. For example, a 1000 lux light sensor will throw this error event when a value greater than 1000 lux is detected.

OVERVOLTAGE Hex: 0x100b

Dec: 4107

Over-Voltage Over-voltage condition detected.

Occurs in power-providing Phidgets when the output voltage exceeds the set value. You can use the getDescription method of the error event to get more information.

FAILSAFE Hex: 0x100c

Dec: 4108

Failsafe Failsafe condition detected.
VOLTAGEERROR Hex: 0x100d

Dec: 4109

Voltage Error Voltage error detected.

A voltage error occurs when a Phidget that provides a voltage output has the value drop below what what specified. This can happen if the device being powered draws too much current, which causes a voltage drop. Stay within output current specifications to avoid voltage errors.

ENERGYDUMP Hex: 0x100e

Dec: 4110

Energy Dump Energy dump condition detected.

An energy dump occurs when a power-providing Phidget needs to dissipate its extra energy. See the User Guide for your device for more information.

MOTORSTALL Hex: 0x100f

Dec: 4111

Motor Stall Motor stall detected.

Occurs when a dangerous motor stall is detected. You can use the getDescription method of the error event to get more information.