Defines
Phidget Constants

Defines

#define PFALSE   0x00
#define PTRUE   0x01

Phidget States

Returned by getStatus() functions

#define PHIDGET_ATTACHED   0x1
#define PHIDGET_NOTATTACHED   0x0

Phidget Error Codes

Returned by all C API calls

#define PHIDGET_ERROR_CODE_COUNT   20
#define EPHIDGET_OK   0
#define EPHIDGET_NOTFOUND   1
#define EPHIDGET_NOMEMORY   2
#define EPHIDGET_UNEXPECTED   3
#define EPHIDGET_INVALIDARG   4
#define EPHIDGET_NOTATTACHED   5
#define EPHIDGET_INTERRUPTED   6
#define EPHIDGET_INVALID   7
#define EPHIDGET_NETWORK   8
#define EPHIDGET_UNKNOWNVAL   9
#define EPHIDGET_BADPASSWORD   10
#define EPHIDGET_UNSUPPORTED   11
#define EPHIDGET_DUPLICATE   12
#define EPHIDGET_TIMEOUT   13
#define EPHIDGET_OUTOFBOUNDS   14
#define EPHIDGET_EVENT   15
#define EPHIDGET_NETWORK_NOTCONNECTED   16
#define EPHIDGET_WRONGDEVICE   17
#define EPHIDGET_CLOSED   18
#define EPHIDGET_BADVERSION   19

Phidget Error Event Codes

Returned in the Phidget error event

#define EEPHIDGET_EVENT_ERROR(code)   (0x8000 + code)
#define EEPHIDGET_NETWORK   EEPHIDGET_EVENT_ERROR(0x0001)
#define EEPHIDGET_BADPASSWORD   EEPHIDGET_EVENT_ERROR(0x0002)
#define EEPHIDGET_BADVERSION   EEPHIDGET_EVENT_ERROR(0x0003)
#define EEPHIDGET_OK   EEPHIDGET_EVENT_ERROR(0x1000)
#define EEPHIDGET_OVERRUN   EEPHIDGET_EVENT_ERROR(0x1002)
#define EEPHIDGET_PACKETLOST   EEPHIDGET_EVENT_ERROR(0x1003)
#define EEPHIDGET_WRAP   EEPHIDGET_EVENT_ERROR(0x1004)
#define EEPHIDGET_OVERTEMP   EEPHIDGET_EVENT_ERROR(0x1005)
#define EEPHIDGET_OVERCURRENT   EEPHIDGET_EVENT_ERROR(0x1006)
#define EEPHIDGET_OUTOFRANGE   EEPHIDGET_EVENT_ERROR(0x1007)
#define EEPHIDGET_BADPOWER   EEPHIDGET_EVENT_ERROR(0x1008)

Phidget Unknown Constants

Data values will be set to these constants when a call fails with EPHIDGET_UNKNOWNVAL.

#define PUNK_BOOL   0x02
#define PUNK_SHRT   0x7FFF
#define PUNK_INT   0x7FFFFFFF
#define PUNK_INT64   0x7FFFFFFFFFFFFFFFLL
#define PUNK_DBL   1e300
#define PUNK_FLT   1e30

Detailed Description

Various constants used throughout the library.


Define Documentation

Authorization Failed.

Definition at line 840 of file phidget21.h.

Power supply problem detected.

Definition at line 851 of file phidget21.h.

Webservice and Client protocol versions don't match. Update to newest release.

Definition at line 841 of file phidget21.h.

#define EEPHIDGET_EVENT_ERROR (   code)    (0x8000 + code)

Definition at line 835 of file phidget21.h.

Network Error (asynchronous).

Definition at line 839 of file phidget21.h.

#define EEPHIDGET_OK   EEPHIDGET_EVENT_ERROR(0x1000)

An error state has ended - see description for details.

Definition at line 844 of file phidget21.h.

Out of range condition detected.

Definition at line 850 of file phidget21.h.

Overcurrent condition detected.

Definition at line 849 of file phidget21.h.

A sampling overrun happend in firmware.

Definition at line 845 of file phidget21.h.

Overtemperature condition detected.

Definition at line 848 of file phidget21.h.

One or more packets were lost.

Definition at line 846 of file phidget21.h.

#define EEPHIDGET_WRAP   EEPHIDGET_EVENT_ERROR(0x1004)

A variable has wrapped around.

Definition at line 847 of file phidget21.h.

#define EPHIDGET_BADPASSWORD   10

Authorization exception. "No longer used. Replaced by EEPHIDGET_BADPASSWORD"

Definition at line 818 of file phidget21.h.

#define EPHIDGET_BADVERSION   19

Version Mismatch. "No longer used. Replaced by EEPHIDGET_BADVERSION"

Definition at line 827 of file phidget21.h.

#define EPHIDGET_CLOSED   18

Phidget Closed. "Phidget handle was closed."

Definition at line 826 of file phidget21.h.

#define EPHIDGET_DUPLICATE   12

Duplicate request. "Duplicated request."

Definition at line 820 of file phidget21.h.

#define EPHIDGET_EVENT   15

Event. "A non-null error code was returned from an event handler." This code is not currently used.

Definition at line 823 of file phidget21.h.

#define EPHIDGET_INTERRUPTED   6

Interrupted. "Read/Write operation was interrupted." This code is not currently used.

Definition at line 814 of file phidget21.h.

#define EPHIDGET_INVALID   7

Invalid error code. "The Error Code is not defined."

Definition at line 815 of file phidget21.h.

#define EPHIDGET_INVALIDARG   4

Invalid argument. "Invalid argument passed to function."

Definition at line 812 of file phidget21.h.

#define EPHIDGET_NETWORK   8

Network. "Network Error."

Definition at line 816 of file phidget21.h.

Network not connected. "A connection to the server does not exist."

Definition at line 824 of file phidget21.h.

#define EPHIDGET_NOMEMORY   2

No memory. "Memory could not be allocated."

Definition at line 810 of file phidget21.h.

#define EPHIDGET_NOTATTACHED   5

Phidget not attached. "Phidget not physically attached."

Definition at line 813 of file phidget21.h.

#define EPHIDGET_NOTFOUND   1

Phidget not found. "A Phidget matching the type and or serial number could not be found."

Definition at line 809 of file phidget21.h.

#define EPHIDGET_OK   0

Function completed successfully.

Definition at line 808 of file phidget21.h.

#define EPHIDGET_OUTOFBOUNDS   14

Out of bounds. "Index out of Bounds."

Definition at line 822 of file phidget21.h.

#define EPHIDGET_TIMEOUT   13

Timeout. "Given timeout has been exceeded."

Definition at line 821 of file phidget21.h.

#define EPHIDGET_UNEXPECTED   3

Unexpected. "Unexpected Error. Contact Phidgets Inc. for support."

Definition at line 811 of file phidget21.h.

#define EPHIDGET_UNKNOWNVAL   9

Value unknown. "Value is Unknown (State not yet received from device, or not yet set by user)."

Definition at line 817 of file phidget21.h.

#define EPHIDGET_UNSUPPORTED   11

Unsupported. "Not Supported."

Definition at line 819 of file phidget21.h.

#define EPHIDGET_WRONGDEVICE   17

Wrong device. "Function is not applicable for this device."

Definition at line 825 of file phidget21.h.

#define PFALSE   0x00

False. Used for boolean values.

Definition at line 867 of file phidget21.h.

#define PHIDGET_ATTACHED   0x1

Phidget attached

Definition at line 798 of file phidget21.h.

#define PHIDGET_ERROR_CODE_COUNT   20

Definition at line 807 of file phidget21.h.

#define PHIDGET_NOTATTACHED   0x0

Phidget not attached

Definition at line 799 of file phidget21.h.

#define PTRUE   0x01

True. Used for boolean values.

Definition at line 868 of file phidget21.h.

#define PUNK_BOOL   0x02

Unknown Boolean (unsigned char)

Definition at line 859 of file phidget21.h.

#define PUNK_DBL   1e300

Unknown Double

Definition at line 863 of file phidget21.h.

#define PUNK_FLT   1e30

Unknown Float

Definition at line 864 of file phidget21.h.

#define PUNK_INT   0x7FFFFFFF

Unknown Integer (32-bit)

Definition at line 861 of file phidget21.h.

#define PUNK_INT64   0x7FFFFFFFFFFFFFFFLL

Unknown Integer (64-bit)

Definition at line 862 of file phidget21.h.

#define PUNK_SHRT   0x7FFF

Unknown Short (16-bit)

Definition at line 860 of file phidget21.h.



phidgets_api
Author(s): Tully Foote, Ivan Dryanovski, Copyright (C) 2010 Phidgets Inc.
autogenerated on Mon Oct 6 2014 03:21:40