de.weAut

Enum PiGpioDdefs.ErrPI

java.lang.Object

java.lang.Enum<PiGpioDdefs.ErrPI>

de.weAut.PiGpioDdefs.ErrPI

All Implemented Interfaces:

Serializable, Comparable<PiGpioDdefs.ErrPI>

Enclosing interface:

PiGpioDdefs

public static enum PiGpioDdefs.ErrPI
extends Enum<PiGpioDdefs.ErrPI>

pigpiod errors plus short explanation as enumeration.

The pigpiod errors -1..-143 plus a very short English explanation are hier as enum objects. Their ordinal numbers 1..143 are the positive error codes:
Enum.ordinal() == -errNum()
This is supplemented by no error (0), a the Python error command interrupted (-144), and a unknown PI_error for a wrong pigpiod error number.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_BUF_MILLIS
BAD_CFG_INTERNAL
BAD_CHAIN_CMD
BAD_CHAIN_DELAY
BAD_CHAIN_LOOP
BAD_CHANNEL
BAD_CLK_MICROS
BAD_CLK_PERIPH
BAD_CLK_SOURCE
BAD_DATABITS
BAD_DUTYCYCLE
BAD_DUTYRANGE
BAD_EDGE
BAD_EVENT_ID
BAD_FIFO_COMMAND
BAD_FILE_FLAG
BAD_FILE_MODE
BAD_FILE_READ
BAD_FILE_SEEK
BAD_FILE_WRITE
BAD_FILTER
BAD_FLAGS
BAD_FOREVER
BAD_GPIO
BAD_HANDLE
BAD_HCLK_FREQ
BAD_HCLK_PASS
BAD_HPWM_DUTY
BAD_HPWM_FREQ
BAD_I2C_ADDR
BAD_I2C_BAUD
BAD_I2C_BUS
BAD_I2C_CMD
BAD_I2C_RLEN
BAD_I2C_SEG
BAD_I2C_WLEN
BAD_IF_FLAGS
BAD_ISR_INIT
BAD_LEVEL
BAD_MALLOC_MODE
BAD_MICROS
BAD_MICS_DELAY
BAD_MILS_DELAY
BAD_MODE
BAD_MS
BAD_PAD
BAD_PARAM
BAD_PARAM_NUM
BAD_PATHNAME
BAD_POINTER
BAD_PUD
BAD_PULSELEN
BAD_PULSEWIDTH
BAD_SCRIPT
BAD_SCRIPT_CMD
BAD_SCRIPT_ID
BAD_SCRIPT_NAME
BAD_SECO_CHANNEL
BAD_SECONDS
BAD_SER_DEVICE
BAD_SER_INVERT
BAD_SER_OFFSET
BAD_SER_SPEED
BAD_SERIAL_BUF
BAD_SERIAL_COUNT
BAD_SERIAL_STRUC
BAD_SHELL_STATUS
BAD_SIGNUM
BAD_SMBUS_CMD
BAD_SOCKET_PORT
BAD_SPI_BAUD
BAD_SPI_CHANNEL
BAD_SPI_COUNT
BAD_SPI_SPEED
BAD_STOPBITS
BAD_STRENGTH
BAD_TAG
BAD_TIMER
BAD_TIMETYPE
BAD_USER_GPIO
BAD_VAR_NUM
BAD_WAVE_BAUD
BAD_WAVE_ID
BAD_WAVE_MODE
BAD_WDOG_TIMEOUT
BAD_WVSC_COMMND
BAD_WVSM_COMMND
BAD_WVSP_COMMND
CHAIN_COUNTER
CHAIN_LOOP_CNT
CHAIN_NESTING
CHAIN_TOO_BIG
CMD_INTERRUPTED
DEPRECATED
DUP_TAG
EMPTY_WAVEFORM
FIL_OPEN_FAILED
FILE_IS_A_DIR
FILE_NOT_ROPEN
FILE_NOT_WOPEN
GPIO_IN_USE
HPWM_ILLEGAL
I2C_OPEN_FAILED
I2C_READ_FAILED
I2C_WRITE_FAILED
INIT_FAILED
INITIALISED
MSG_TOOBIG
NO_ALERT_FUNC
NO_AUX_SPI
NO_ERROR
NO_FILE_ACCESS
NO_FILE_MATCH
NO_HANDLE
NO_MEMORY
NO_SCRIPT_ROOM
NO_WAVEFORM_ID
NOT_HCLK_GPIO
NOT_HPWM_GPIO
NOT_I2C_GPIO
NOT_INITIALISED
NOT_PERMITTED
NOT_PWM_GPIO
NOT_SERIAL_GPIO
NOT_SERVO_GPIO
NOT_SPI_GPIO
SCRIPT_NOT_READY
SER_OPEN_FAILED
SER_READ_FAILED
SER_READ_NO_DATA
SER_WRITE_FAILED
SOCK_READ_FAILED
SOCK_WRIT_FAILED
SOME_PERMITTED
SPI_OPEN_FAILED
SPI_XFER_FAILED
TIMER_FAILED
TOO_MANY_CBS
TOO_MANY_CHARS
TOO_MANY_OOL
TOO_MANY_PARAM
TOO_MANY_PULSES
TOO_MANY_SEGS
TOO_MANY_TAGS
UNKNOWN_COMMAND
UNKNOWN_ERROR

Field Summary

Fields

Modifier and Type	Field and Description
String	expl The pigpiod error's short explanation.

Method Summary

Modifier and Type	Method and Description
static PiGpioDdefs.ErrPI	byErrNum(int num) Get explained error by error number (-) or index.
int	errNum() Get the error number (-).
static void	main(String[] args) The enum ErrPi as application.
String	toString() Description of the enum object.
static PiGpioDdefs.ErrPI	valueOf(String name) Returns the enum constant of this type with the specified name.
static PiGpioDdefs.ErrPI[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_ERROR

public static final PiGpioDdefs.ErrPI NO_ERROR

INIT_FAILED

public static final PiGpioDdefs.ErrPI INIT_FAILED

BAD_USER_GPIO

public static final PiGpioDdefs.ErrPI BAD_USER_GPIO

BAD_GPIO

public static final PiGpioDdefs.ErrPI BAD_GPIO

BAD_MODE

public static final PiGpioDdefs.ErrPI BAD_MODE

BAD_LEVEL

public static final PiGpioDdefs.ErrPI BAD_LEVEL

BAD_PUD

public static final PiGpioDdefs.ErrPI BAD_PUD

BAD_PULSEWIDTH

public static final PiGpioDdefs.ErrPI BAD_PULSEWIDTH

BAD_DUTYCYCLE

public static final PiGpioDdefs.ErrPI BAD_DUTYCYCLE

BAD_TIMER

public static final PiGpioDdefs.ErrPI BAD_TIMER

BAD_MS

public static final PiGpioDdefs.ErrPI BAD_MS

BAD_TIMETYPE

public static final PiGpioDdefs.ErrPI BAD_TIMETYPE

BAD_SECONDS

public static final PiGpioDdefs.ErrPI BAD_SECONDS

BAD_MICROS

public static final PiGpioDdefs.ErrPI BAD_MICROS

TIMER_FAILED

public static final PiGpioDdefs.ErrPI TIMER_FAILED

BAD_WDOG_TIMEOUT

public static final PiGpioDdefs.ErrPI BAD_WDOG_TIMEOUT

NO_ALERT_FUNC

public static final PiGpioDdefs.ErrPI NO_ALERT_FUNC

BAD_CLK_PERIPH

public static final PiGpioDdefs.ErrPI BAD_CLK_PERIPH

BAD_CLK_SOURCE

public static final PiGpioDdefs.ErrPI BAD_CLK_SOURCE

BAD_CLK_MICROS

public static final PiGpioDdefs.ErrPI BAD_CLK_MICROS

BAD_BUF_MILLIS

public static final PiGpioDdefs.ErrPI BAD_BUF_MILLIS

BAD_DUTYRANGE

public static final PiGpioDdefs.ErrPI BAD_DUTYRANGE

BAD_SIGNUM

public static final PiGpioDdefs.ErrPI BAD_SIGNUM

BAD_PATHNAME

public static final PiGpioDdefs.ErrPI BAD_PATHNAME

NO_HANDLE

public static final PiGpioDdefs.ErrPI NO_HANDLE

BAD_HANDLE

public static final PiGpioDdefs.ErrPI BAD_HANDLE

BAD_IF_FLAGS

public static final PiGpioDdefs.ErrPI BAD_IF_FLAGS

BAD_CHANNEL

public static final PiGpioDdefs.ErrPI BAD_CHANNEL

BAD_SOCKET_PORT

public static final PiGpioDdefs.ErrPI BAD_SOCKET_PORT

BAD_FIFO_COMMAND

public static final PiGpioDdefs.ErrPI BAD_FIFO_COMMAND

BAD_SECO_CHANNEL

public static final PiGpioDdefs.ErrPI BAD_SECO_CHANNEL

NOT_INITIALISED

public static final PiGpioDdefs.ErrPI NOT_INITIALISED

INITIALISED

public static final PiGpioDdefs.ErrPI INITIALISED

BAD_WAVE_MODE

public static final PiGpioDdefs.ErrPI BAD_WAVE_MODE

BAD_CFG_INTERNAL

public static final PiGpioDdefs.ErrPI BAD_CFG_INTERNAL

BAD_WAVE_BAUD

public static final PiGpioDdefs.ErrPI BAD_WAVE_BAUD

TOO_MANY_PULSES

public static final PiGpioDdefs.ErrPI TOO_MANY_PULSES

TOO_MANY_CHARS

public static final PiGpioDdefs.ErrPI TOO_MANY_CHARS

NOT_SERIAL_GPIO

public static final PiGpioDdefs.ErrPI NOT_SERIAL_GPIO

BAD_SERIAL_STRUC

public static final PiGpioDdefs.ErrPI BAD_SERIAL_STRUC

BAD_SERIAL_BUF

public static final PiGpioDdefs.ErrPI BAD_SERIAL_BUF

NOT_PERMITTED

public static final PiGpioDdefs.ErrPI NOT_PERMITTED

SOME_PERMITTED

public static final PiGpioDdefs.ErrPI SOME_PERMITTED

BAD_WVSC_COMMND

public static final PiGpioDdefs.ErrPI BAD_WVSC_COMMND

BAD_WVSM_COMMND

public static final PiGpioDdefs.ErrPI BAD_WVSM_COMMND

BAD_WVSP_COMMND

public static final PiGpioDdefs.ErrPI BAD_WVSP_COMMND

BAD_PULSELEN

public static final PiGpioDdefs.ErrPI BAD_PULSELEN

BAD_SCRIPT

public static final PiGpioDdefs.ErrPI BAD_SCRIPT

BAD_SCRIPT_ID

public static final PiGpioDdefs.ErrPI BAD_SCRIPT_ID

BAD_SER_OFFSET

public static final PiGpioDdefs.ErrPI BAD_SER_OFFSET

GPIO_IN_USE

public static final PiGpioDdefs.ErrPI GPIO_IN_USE

BAD_SERIAL_COUNT

public static final PiGpioDdefs.ErrPI BAD_SERIAL_COUNT

BAD_PARAM_NUM

public static final PiGpioDdefs.ErrPI BAD_PARAM_NUM

DUP_TAG

public static final PiGpioDdefs.ErrPI DUP_TAG

TOO_MANY_TAGS

public static final PiGpioDdefs.ErrPI TOO_MANY_TAGS

BAD_SCRIPT_CMD

public static final PiGpioDdefs.ErrPI BAD_SCRIPT_CMD

BAD_VAR_NUM

public static final PiGpioDdefs.ErrPI BAD_VAR_NUM

NO_SCRIPT_ROOM

public static final PiGpioDdefs.ErrPI NO_SCRIPT_ROOM

NO_MEMORY

public static final PiGpioDdefs.ErrPI NO_MEMORY

SOCK_READ_FAILED

public static final PiGpioDdefs.ErrPI SOCK_READ_FAILED

SOCK_WRIT_FAILED

public static final PiGpioDdefs.ErrPI SOCK_WRIT_FAILED

TOO_MANY_PARAM

public static final PiGpioDdefs.ErrPI TOO_MANY_PARAM

SCRIPT_NOT_READY

public static final PiGpioDdefs.ErrPI SCRIPT_NOT_READY

BAD_TAG

public static final PiGpioDdefs.ErrPI BAD_TAG

BAD_MICS_DELAY

public static final PiGpioDdefs.ErrPI BAD_MICS_DELAY

BAD_MILS_DELAY

public static final PiGpioDdefs.ErrPI BAD_MILS_DELAY

BAD_WAVE_ID

public static final PiGpioDdefs.ErrPI BAD_WAVE_ID

TOO_MANY_CBS

public static final PiGpioDdefs.ErrPI TOO_MANY_CBS

TOO_MANY_OOL

public static final PiGpioDdefs.ErrPI TOO_MANY_OOL

EMPTY_WAVEFORM

public static final PiGpioDdefs.ErrPI EMPTY_WAVEFORM

NO_WAVEFORM_ID

public static final PiGpioDdefs.ErrPI NO_WAVEFORM_ID

I2C_OPEN_FAILED

public static final PiGpioDdefs.ErrPI I2C_OPEN_FAILED

SER_OPEN_FAILED

public static final PiGpioDdefs.ErrPI SER_OPEN_FAILED

SPI_OPEN_FAILED

public static final PiGpioDdefs.ErrPI SPI_OPEN_FAILED

BAD_I2C_BUS

public static final PiGpioDdefs.ErrPI BAD_I2C_BUS

BAD_I2C_ADDR

public static final PiGpioDdefs.ErrPI BAD_I2C_ADDR

BAD_SPI_CHANNEL

public static final PiGpioDdefs.ErrPI BAD_SPI_CHANNEL

BAD_FLAGS

public static final PiGpioDdefs.ErrPI BAD_FLAGS

BAD_SPI_SPEED

public static final PiGpioDdefs.ErrPI BAD_SPI_SPEED

BAD_SER_DEVICE

public static final PiGpioDdefs.ErrPI BAD_SER_DEVICE

BAD_SER_SPEED

public static final PiGpioDdefs.ErrPI BAD_SER_SPEED

BAD_PARAM

public static final PiGpioDdefs.ErrPI BAD_PARAM

I2C_WRITE_FAILED

public static final PiGpioDdefs.ErrPI I2C_WRITE_FAILED

I2C_READ_FAILED

public static final PiGpioDdefs.ErrPI I2C_READ_FAILED

BAD_SPI_COUNT

public static final PiGpioDdefs.ErrPI BAD_SPI_COUNT

SER_WRITE_FAILED

public static final PiGpioDdefs.ErrPI SER_WRITE_FAILED

SER_READ_FAILED

public static final PiGpioDdefs.ErrPI SER_READ_FAILED

SER_READ_NO_DATA

public static final PiGpioDdefs.ErrPI SER_READ_NO_DATA

UNKNOWN_COMMAND

public static final PiGpioDdefs.ErrPI UNKNOWN_COMMAND

SPI_XFER_FAILED

public static final PiGpioDdefs.ErrPI SPI_XFER_FAILED

BAD_POINTER

public static final PiGpioDdefs.ErrPI BAD_POINTER

NO_AUX_SPI

public static final PiGpioDdefs.ErrPI NO_AUX_SPI

NOT_PWM_GPIO

public static final PiGpioDdefs.ErrPI NOT_PWM_GPIO

NOT_SERVO_GPIO

public static final PiGpioDdefs.ErrPI NOT_SERVO_GPIO

NOT_HCLK_GPIO

public static final PiGpioDdefs.ErrPI NOT_HCLK_GPIO

NOT_HPWM_GPIO

public static final PiGpioDdefs.ErrPI NOT_HPWM_GPIO

BAD_HPWM_FREQ

public static final PiGpioDdefs.ErrPI BAD_HPWM_FREQ

BAD_HPWM_DUTY

public static final PiGpioDdefs.ErrPI BAD_HPWM_DUTY

BAD_HCLK_FREQ

public static final PiGpioDdefs.ErrPI BAD_HCLK_FREQ

BAD_HCLK_PASS

public static final PiGpioDdefs.ErrPI BAD_HCLK_PASS

HPWM_ILLEGAL

public static final PiGpioDdefs.ErrPI HPWM_ILLEGAL

BAD_DATABITS

public static final PiGpioDdefs.ErrPI BAD_DATABITS

BAD_STOPBITS

public static final PiGpioDdefs.ErrPI BAD_STOPBITS

MSG_TOOBIG

public static final PiGpioDdefs.ErrPI MSG_TOOBIG

BAD_MALLOC_MODE

public static final PiGpioDdefs.ErrPI BAD_MALLOC_MODE

TOO_MANY_SEGS

public static final PiGpioDdefs.ErrPI TOO_MANY_SEGS

BAD_I2C_SEG

public static final PiGpioDdefs.ErrPI BAD_I2C_SEG

BAD_SMBUS_CMD

public static final PiGpioDdefs.ErrPI BAD_SMBUS_CMD

NOT_I2C_GPIO

public static final PiGpioDdefs.ErrPI NOT_I2C_GPIO

BAD_I2C_WLEN

public static final PiGpioDdefs.ErrPI BAD_I2C_WLEN

BAD_I2C_RLEN

public static final PiGpioDdefs.ErrPI BAD_I2C_RLEN

BAD_I2C_CMD

public static final PiGpioDdefs.ErrPI BAD_I2C_CMD

BAD_I2C_BAUD

public static final PiGpioDdefs.ErrPI BAD_I2C_BAUD

CHAIN_LOOP_CNT

public static final PiGpioDdefs.ErrPI CHAIN_LOOP_CNT

BAD_CHAIN_LOOP

public static final PiGpioDdefs.ErrPI BAD_CHAIN_LOOP

CHAIN_COUNTER

public static final PiGpioDdefs.ErrPI CHAIN_COUNTER

BAD_CHAIN_CMD

public static final PiGpioDdefs.ErrPI BAD_CHAIN_CMD

BAD_CHAIN_DELAY

public static final PiGpioDdefs.ErrPI BAD_CHAIN_DELAY

CHAIN_NESTING

public static final PiGpioDdefs.ErrPI CHAIN_NESTING

CHAIN_TOO_BIG

public static final PiGpioDdefs.ErrPI CHAIN_TOO_BIG

DEPRECATED

public static final PiGpioDdefs.ErrPI DEPRECATED

BAD_SER_INVERT

public static final PiGpioDdefs.ErrPI BAD_SER_INVERT

BAD_EDGE

public static final PiGpioDdefs.ErrPI BAD_EDGE

BAD_ISR_INIT

public static final PiGpioDdefs.ErrPI BAD_ISR_INIT

BAD_FOREVER

public static final PiGpioDdefs.ErrPI BAD_FOREVER

BAD_FILTER

public static final PiGpioDdefs.ErrPI BAD_FILTER

BAD_PAD

public static final PiGpioDdefs.ErrPI BAD_PAD

BAD_STRENGTH

public static final PiGpioDdefs.ErrPI BAD_STRENGTH

FIL_OPEN_FAILED

public static final PiGpioDdefs.ErrPI FIL_OPEN_FAILED

BAD_FILE_MODE

public static final PiGpioDdefs.ErrPI BAD_FILE_MODE

BAD_FILE_FLAG

public static final PiGpioDdefs.ErrPI BAD_FILE_FLAG

BAD_FILE_READ

public static final PiGpioDdefs.ErrPI BAD_FILE_READ

BAD_FILE_WRITE

public static final PiGpioDdefs.ErrPI BAD_FILE_WRITE

FILE_NOT_ROPEN

public static final PiGpioDdefs.ErrPI FILE_NOT_ROPEN

FILE_NOT_WOPEN

public static final PiGpioDdefs.ErrPI FILE_NOT_WOPEN

BAD_FILE_SEEK

public static final PiGpioDdefs.ErrPI BAD_FILE_SEEK

NO_FILE_MATCH

public static final PiGpioDdefs.ErrPI NO_FILE_MATCH

NO_FILE_ACCESS

public static final PiGpioDdefs.ErrPI NO_FILE_ACCESS

FILE_IS_A_DIR

public static final PiGpioDdefs.ErrPI FILE_IS_A_DIR

BAD_SHELL_STATUS

public static final PiGpioDdefs.ErrPI BAD_SHELL_STATUS

BAD_SCRIPT_NAME

public static final PiGpioDdefs.ErrPI BAD_SCRIPT_NAME

BAD_SPI_BAUD

public static final PiGpioDdefs.ErrPI BAD_SPI_BAUD

NOT_SPI_GPIO

public static final PiGpioDdefs.ErrPI NOT_SPI_GPIO

BAD_EVENT_ID

public static final PiGpioDdefs.ErrPI BAD_EVENT_ID

CMD_INTERRUPTED

public static final PiGpioDdefs.ErrPI CMD_INTERRUPTED

UNKNOWN_ERROR

public static final PiGpioDdefs.ErrPI UNKNOWN_ERROR

Field Detail

expl

public final String expl

The pigpiod error's short explanation.

Method Detail

values

public static PiGpioDdefs.ErrPI[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PiGpioDdefs.ErrPI c : PiGpioDdefs.ErrPI.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PiGpioDdefs.ErrPI valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

byErrNum

public static PiGpioDdefs.ErrPI byErrNum(int num)

Get explained error by error number (-) or index.

Parameters:

num - the negative error number or its absolute (positive) value

Returns:

the error enum object or UNKNOWN_ERROR;
0 yields NO_ERROR

errNum

public int errNum()

Get the error number (-).

Returns:

the error number; it is negative (-Enum.ordinal())

toString

public String toString()

Description of the enum object.

This method returns a description in the form
ErrPI.NOT_PERMITTED -41: GPIO operation not permitted

Overrides:

toString in class Enum<PiGpioDdefs.ErrPI>

main

public static void main(String[] args)

The enum ErrPi as application.

This little helper lists all enum (pigpiod error) objects on standard output. Thats a nice list for reference.
Additionally, if something should be changed or added, this is the test output to check the correct error number assignment.
N.b.: for this enum class must hold:
Enum.ordinal() == -errNum()

Hint: Start this application by
java de.weAut.PiGpioDdefs$ErrPI

Parameters:

args - start parameters, ignored