ErrPI ( Frame4J -- the Java framework de.frame4j... )

java.lang.Object
- java.lang.Enum<ErrPI>
- - de.weAut.ErrPI

All Implemented Interfaces:

Serializable, Comparable<ErrPI>
```
public enum ErrPI
extends Enum<ErrPI>
```
pigpiod errors plus short explanation as enumeration.

The pigpiod #errNum() errors) -1..-143 plus a very short English {@link #expl explanation} are hier as enum objects. Their {@link #ordinal() ordinal) numbers 1..143 are the positive {@linkplain #errNum() error codes):
{@link #ordinal()}{@code == -}{@link #errNum()
This is supplemented by {@link #NO_ERROR no error (0)}, a the Python error {@link #CMD_INTERRUPTED command interrupted (-144)}, and a {@link #UNKNOWN_ERROR 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.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ErrPI`	`byErrNum(int num)` Get explained error by error number (-) or index.
`int`	`errNum()` Get the error number (-).
`static void`	`main(String[] args)`
`String`	`toString()`
`static ErrPI`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static 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 ErrPI NO_ERROR
```

INIT_FAILED
```
public static final ErrPI INIT_FAILED
```

BAD_USER_GPIO

public static final ErrPI BAD_USER_GPIO

BAD_GPIO
```
public static final ErrPI BAD_GPIO
```

BAD_MODE
```
public static final ErrPI BAD_MODE
```

BAD_LEVEL
```
public static final ErrPI BAD_LEVEL
```

BAD_PUD
```
public static final ErrPI BAD_PUD
```

BAD_PULSEWIDTH

public static final ErrPI BAD_PULSEWIDTH

BAD_DUTYCYCLE

public static final ErrPI BAD_DUTYCYCLE

BAD_TIMER
```
public static final ErrPI BAD_TIMER
```

BAD_MS
```
public static final ErrPI BAD_MS
```

BAD_TIMETYPE
```
public static final ErrPI BAD_TIMETYPE
```

BAD_SECONDS
```
public static final ErrPI BAD_SECONDS
```

BAD_MICROS
```
public static final ErrPI BAD_MICROS
```

TIMER_FAILED
```
public static final ErrPI TIMER_FAILED
```

BAD_WDOG_TIMEOUT

public static final ErrPI BAD_WDOG_TIMEOUT

NO_ALERT_FUNC

public static final ErrPI NO_ALERT_FUNC

BAD_CLK_PERIPH

public static final ErrPI BAD_CLK_PERIPH

BAD_CLK_SOURCE

public static final ErrPI BAD_CLK_SOURCE

BAD_CLK_MICROS

public static final ErrPI BAD_CLK_MICROS

BAD_BUF_MILLIS

public static final ErrPI BAD_BUF_MILLIS

BAD_DUTYRANGE

public static final ErrPI BAD_DUTYRANGE

BAD_SIGNUM
```
public static final ErrPI BAD_SIGNUM
```

BAD_PATHNAME
```
public static final ErrPI BAD_PATHNAME
```

NO_HANDLE
```
public static final ErrPI NO_HANDLE
```

BAD_HANDLE
```
public static final ErrPI BAD_HANDLE
```

BAD_IF_FLAGS
```
public static final ErrPI BAD_IF_FLAGS
```

BAD_CHANNEL
```
public static final ErrPI BAD_CHANNEL
```

BAD_SOCKET_PORT

public static final ErrPI BAD_SOCKET_PORT

BAD_FIFO_COMMAND

public static final ErrPI BAD_FIFO_COMMAND

BAD_SECO_CHANNEL

public static final ErrPI BAD_SECO_CHANNEL

NOT_INITIALISED

public static final ErrPI NOT_INITIALISED

INITIALISED
```
public static final ErrPI INITIALISED
```

BAD_WAVE_MODE

public static final ErrPI BAD_WAVE_MODE

BAD_CFG_INTERNAL

public static final ErrPI BAD_CFG_INTERNAL

BAD_WAVE_BAUD

public static final ErrPI BAD_WAVE_BAUD

TOO_MANY_PULSES

public static final ErrPI TOO_MANY_PULSES

TOO_MANY_CHARS

public static final ErrPI TOO_MANY_CHARS

NOT_SERIAL_GPIO

public static final ErrPI NOT_SERIAL_GPIO

BAD_SERIAL_STRUC

public static final ErrPI BAD_SERIAL_STRUC

BAD_SERIAL_BUF

public static final ErrPI BAD_SERIAL_BUF

NOT_PERMITTED

public static final ErrPI NOT_PERMITTED

SOME_PERMITTED

public static final ErrPI SOME_PERMITTED

BAD_WVSC_COMMND

public static final ErrPI BAD_WVSC_COMMND

BAD_WVSM_COMMND

public static final ErrPI BAD_WVSM_COMMND

BAD_WVSP_COMMND

public static final ErrPI BAD_WVSP_COMMND

BAD_PULSELEN
```
public static final ErrPI BAD_PULSELEN
```

BAD_SCRIPT
```
public static final ErrPI BAD_SCRIPT
```

BAD_SCRIPT_ID

public static final ErrPI BAD_SCRIPT_ID

BAD_SER_OFFSET

public static final ErrPI BAD_SER_OFFSET

GPIO_IN_USE
```
public static final ErrPI GPIO_IN_USE
```

BAD_SERIAL_COUNT

public static final ErrPI BAD_SERIAL_COUNT

BAD_PARAM_NUM

public static final ErrPI BAD_PARAM_NUM

DUP_TAG
```
public static final ErrPI DUP_TAG
```

TOO_MANY_TAGS

public static final ErrPI TOO_MANY_TAGS

BAD_SCRIPT_CMD

public static final ErrPI BAD_SCRIPT_CMD

BAD_VAR_NUM
```
public static final ErrPI BAD_VAR_NUM
```

NO_SCRIPT_ROOM

public static final ErrPI NO_SCRIPT_ROOM

NO_MEMORY
```
public static final ErrPI NO_MEMORY
```

SOCK_READ_FAILED

public static final ErrPI SOCK_READ_FAILED

SOCK_WRIT_FAILED

public static final ErrPI SOCK_WRIT_FAILED

TOO_MANY_PARAM

public static final ErrPI TOO_MANY_PARAM

SCRIPT_NOT_READY

public static final ErrPI SCRIPT_NOT_READY

BAD_TAG
```
public static final ErrPI BAD_TAG
```

BAD_MICS_DELAY

public static final ErrPI BAD_MICS_DELAY

BAD_MILS_DELAY

public static final ErrPI BAD_MILS_DELAY

BAD_WAVE_ID
```
public static final ErrPI BAD_WAVE_ID
```

TOO_MANY_CBS
```
public static final ErrPI TOO_MANY_CBS
```

TOO_MANY_OOL
```
public static final ErrPI TOO_MANY_OOL
```

EMPTY_WAVEFORM

public static final ErrPI EMPTY_WAVEFORM

NO_WAVEFORM_ID

public static final ErrPI NO_WAVEFORM_ID

I2C_OPEN_FAILED

public static final ErrPI I2C_OPEN_FAILED

SER_OPEN_FAILED

public static final ErrPI SER_OPEN_FAILED

SPI_OPEN_FAILED

public static final ErrPI SPI_OPEN_FAILED

BAD_I2C_BUS
```
public static final ErrPI BAD_I2C_BUS
```

BAD_I2C_ADDR
```
public static final ErrPI BAD_I2C_ADDR
```

BAD_SPI_CHANNEL

public static final ErrPI BAD_SPI_CHANNEL

BAD_FLAGS
```
public static final ErrPI BAD_FLAGS
```

BAD_SPI_SPEED

public static final ErrPI BAD_SPI_SPEED

BAD_SER_DEVICE

public static final ErrPI BAD_SER_DEVICE

BAD_SER_SPEED

public static final ErrPI BAD_SER_SPEED

BAD_PARAM
```
public static final ErrPI BAD_PARAM
```

I2C_WRITE_FAILED

public static final ErrPI I2C_WRITE_FAILED

I2C_READ_FAILED

public static final ErrPI I2C_READ_FAILED

BAD_SPI_COUNT

public static final ErrPI BAD_SPI_COUNT

SER_WRITE_FAILED

public static final ErrPI SER_WRITE_FAILED

SER_READ_FAILED

public static final ErrPI SER_READ_FAILED

SER_READ_NO_DATA

public static final ErrPI SER_READ_NO_DATA

UNKNOWN_COMMAND

public static final ErrPI UNKNOWN_COMMAND

SPI_XFER_FAILED

public static final ErrPI SPI_XFER_FAILED

BAD_POINTER
```
public static final ErrPI BAD_POINTER
```

NO_AUX_SPI
```
public static final ErrPI NO_AUX_SPI
```

NOT_PWM_GPIO
```
public static final ErrPI NOT_PWM_GPIO
```

NOT_SERVO_GPIO

public static final ErrPI NOT_SERVO_GPIO

NOT_HCLK_GPIO

public static final ErrPI NOT_HCLK_GPIO

NOT_HPWM_GPIO

public static final ErrPI NOT_HPWM_GPIO

BAD_HPWM_FREQ

public static final ErrPI BAD_HPWM_FREQ

BAD_HPWM_DUTY

public static final ErrPI BAD_HPWM_DUTY

BAD_HCLK_FREQ

public static final ErrPI BAD_HCLK_FREQ

BAD_HCLK_PASS

public static final ErrPI BAD_HCLK_PASS

HPWM_ILLEGAL
```
public static final ErrPI HPWM_ILLEGAL
```

BAD_DATABITS
```
public static final ErrPI BAD_DATABITS
```

BAD_STOPBITS
```
public static final ErrPI BAD_STOPBITS
```

MSG_TOOBIG
```
public static final ErrPI MSG_TOOBIG
```

BAD_MALLOC_MODE

public static final ErrPI BAD_MALLOC_MODE

TOO_MANY_SEGS

public static final ErrPI TOO_MANY_SEGS

BAD_I2C_SEG
```
public static final ErrPI BAD_I2C_SEG
```

BAD_SMBUS_CMD

public static final ErrPI BAD_SMBUS_CMD

NOT_I2C_GPIO
```
public static final ErrPI NOT_I2C_GPIO
```

BAD_I2C_WLEN
```
public static final ErrPI BAD_I2C_WLEN
```

BAD_I2C_RLEN
```
public static final ErrPI BAD_I2C_RLEN
```

BAD_I2C_CMD
```
public static final ErrPI BAD_I2C_CMD
```

BAD_I2C_BAUD
```
public static final ErrPI BAD_I2C_BAUD
```

CHAIN_LOOP_CNT

public static final ErrPI CHAIN_LOOP_CNT

BAD_CHAIN_LOOP

public static final ErrPI BAD_CHAIN_LOOP

CHAIN_COUNTER

public static final ErrPI CHAIN_COUNTER

BAD_CHAIN_CMD

public static final ErrPI BAD_CHAIN_CMD

BAD_CHAIN_DELAY

public static final ErrPI BAD_CHAIN_DELAY

CHAIN_NESTING

public static final ErrPI CHAIN_NESTING

CHAIN_TOO_BIG

public static final ErrPI CHAIN_TOO_BIG

DEPRECATED
```
public static final ErrPI DEPRECATED
```

BAD_SER_INVERT

public static final ErrPI BAD_SER_INVERT

BAD_EDGE
```
public static final ErrPI BAD_EDGE
```

BAD_ISR_INIT
```
public static final ErrPI BAD_ISR_INIT
```

BAD_FOREVER
```
public static final ErrPI BAD_FOREVER
```

BAD_FILTER
```
public static final ErrPI BAD_FILTER
```

BAD_PAD
```
public static final ErrPI BAD_PAD
```

BAD_STRENGTH
```
public static final ErrPI BAD_STRENGTH
```

FIL_OPEN_FAILED

public static final ErrPI FIL_OPEN_FAILED

BAD_FILE_MODE

public static final ErrPI BAD_FILE_MODE

BAD_FILE_FLAG

public static final ErrPI BAD_FILE_FLAG

BAD_FILE_READ

public static final ErrPI BAD_FILE_READ

BAD_FILE_WRITE

public static final ErrPI BAD_FILE_WRITE

FILE_NOT_ROPEN

public static final ErrPI FILE_NOT_ROPEN

FILE_NOT_WOPEN

public static final ErrPI FILE_NOT_WOPEN

BAD_FILE_SEEK

public static final ErrPI BAD_FILE_SEEK

NO_FILE_MATCH

public static final ErrPI NO_FILE_MATCH

NO_FILE_ACCESS

public static final ErrPI NO_FILE_ACCESS

FILE_IS_A_DIR

public static final ErrPI FILE_IS_A_DIR

BAD_SHELL_STATUS

public static final ErrPI BAD_SHELL_STATUS

BAD_SCRIPT_NAME

public static final ErrPI BAD_SCRIPT_NAME

BAD_SPI_BAUD
```
public static final ErrPI BAD_SPI_BAUD
```

NOT_SPI_GPIO
```
public static final ErrPI NOT_SPI_GPIO
```

BAD_EVENT_ID
```
public static final ErrPI BAD_EVENT_ID
```

CMD_INTERRUPTED

public static final ErrPI CMD_INTERRUPTED

UNKNOWN_ERROR

public static final ErrPI UNKNOWN_ERROR

Field Detail
- expl
```
public final String expl
```
  The pigpiod error's short explanation.

Method Detail
- values
```
public static 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 (ErrPI c : 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 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 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 #PPI_UNKNOWN_ERROR;
  0 yields #PI_NO_ERROR
- errNum
```
public int errNum()
```
  Get the error number (-).
  
  Returns:
  
  the error number; it is negative (-Enum.ordinal()
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Enum<ErrPI>
- main
```
public static void main(String[] args)
```

Enum ErrPI

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NO_ERROR

INIT_FAILED

BAD_USER_GPIO

BAD_GPIO

BAD_MODE

BAD_LEVEL

BAD_PUD

BAD_PULSEWIDTH

BAD_DUTYCYCLE

BAD_TIMER

BAD_MS

BAD_TIMETYPE

BAD_SECONDS

BAD_MICROS

TIMER_FAILED

BAD_WDOG_TIMEOUT

NO_ALERT_FUNC

BAD_CLK_PERIPH

BAD_CLK_SOURCE

BAD_CLK_MICROS

BAD_BUF_MILLIS

BAD_DUTYRANGE

BAD_SIGNUM

BAD_PATHNAME

NO_HANDLE

BAD_HANDLE

BAD_IF_FLAGS

BAD_CHANNEL

BAD_SOCKET_PORT

BAD_FIFO_COMMAND

BAD_SECO_CHANNEL

NOT_INITIALISED

INITIALISED

BAD_WAVE_MODE

BAD_CFG_INTERNAL

BAD_WAVE_BAUD

TOO_MANY_PULSES

TOO_MANY_CHARS

NOT_SERIAL_GPIO

BAD_SERIAL_STRUC

BAD_SERIAL_BUF

NOT_PERMITTED

SOME_PERMITTED

BAD_WVSC_COMMND

BAD_WVSM_COMMND

BAD_WVSP_COMMND

BAD_PULSELEN

BAD_SCRIPT

BAD_SCRIPT_ID

BAD_SER_OFFSET

GPIO_IN_USE

BAD_SERIAL_COUNT

BAD_PARAM_NUM

DUP_TAG

TOO_MANY_TAGS

BAD_SCRIPT_CMD

BAD_VAR_NUM

NO_SCRIPT_ROOM

NO_MEMORY

SOCK_READ_FAILED

SOCK_WRIT_FAILED

TOO_MANY_PARAM

SCRIPT_NOT_READY

BAD_TAG

BAD_MICS_DELAY

BAD_MILS_DELAY

BAD_WAVE_ID

TOO_MANY_CBS

TOO_MANY_OOL

EMPTY_WAVEFORM

NO_WAVEFORM_ID

I2C_OPEN_FAILED

SER_OPEN_FAILED