SystemBit (LSST CCS - Parker Motor Driver 2.2 API)

java.lang.Object
- java.lang.Enum<SystemBit>
- - org.lsst.ccs.drivers.parker.SystemBit

All Implemented Interfaces:

Serializable, Comparable<SystemBit>
```
public enum SystemBit
extends Enum<SystemBit>
```
Defines names and numbers for some system bits, that is, bits not associated with a master, axis, program or encoder.
Note that not all input and output lines named here are provided by every model of ACR-like controller. There are also restrictions on which inputs can be used as triggers for data capture during motion. Some will be assigned to limit and home switches. See the hardware installation model for your controller model, which will also say which connector pins are used for each input or output. Two pins are used for each input or output.

Author:

tether

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CLEAR_LATCHED_MOTION_DISABLE` (ACR9000) Set this bit to clear a latched motion disable, assuming that the Motion Enable input has voltage again.
`INPUT_LINE0` Opto-isolated input #0.
`INPUT_LINE1` Opto-isolated input #1.
`INPUT_LINE10` Opto-isolated input #10.
`INPUT_LINE11` Opto-isolated input #11.
`INPUT_LINE12` Opto-isolated input #12.
`INPUT_LINE13` Opto-isolated input #13.
`INPUT_LINE14` Opto-isolated input #14.
`INPUT_LINE15` Opto-isolated input #15.
`INPUT_LINE16` Opto-isolated input #15.
`INPUT_LINE17` Opto-isolated input #15.
`INPUT_LINE18` Opto-isolated input #15.
`INPUT_LINE19` Opto-isolated input #15.
`INPUT_LINE2` Opto-isolated input #2.
`INPUT_LINE20` Opto-isolated input #15.
`INPUT_LINE21` Opto-isolated input #15.
`INPUT_LINE22` Opto-isolated input #15.
`INPUT_LINE23` Opto-isolated input #15.
`INPUT_LINE24` Opto-isolated input #15.
`INPUT_LINE25` Opto-isolated input #15.
`INPUT_LINE26` Opto-isolated input #15.
`INPUT_LINE27` Opto-isolated input #15.
`INPUT_LINE28` Opto-isolated input #15.
`INPUT_LINE29` Opto-isolated input #15.
`INPUT_LINE3` Opto-isolated input #3.
`INPUT_LINE30` Opto-isolated input #15.
`INPUT_LINE31` Opto-isolated input #15.
`INPUT_LINE4` Opto-isolated input #4.
`INPUT_LINE5` Opto-isolated input #5.
`INPUT_LINE6` Opto-isolated input #6.
`INPUT_LINE7` Opto-isolated input #7.
`INPUT_LINE8` Opto-isolated input #8.
`INPUT_LINE9` Opto-isolated input #9.
`LATCHED_MOTION_DISABLE` (ACR9000) Turns on when the Motion Enable input loses voltage and remains on until the CLEAR_LATCHED_MOTION_DISABLE bit is set.
`MOTION_DISABLE` (ACR9000) Indicates that the Motion Enable currently has no voltage (is open).
`OUTPUT_LINE32` Opto-isolated output #32.
`OUTPUT_LINE33` Opto-isolated output #33.
`OUTPUT_LINE34` Opto-isolated output #34.
`OUTPUT_LINE35` Opto-isolated output #35.
`OUTPUT_LINE36` Opto-isolated output #36.
`OUTPUT_LINE37` Opto-isolated output #37.
`OUTPUT_LINE38` Opto-isolated output #38.
`OUTPUT_LINE39` Opto-isolated output #39.
`OUTPUT_LINE40` Opto-isolated output #40.
`OUTPUT_LINE41` Opto-isolated output #41.
`OUTPUT_LINE42` Opto-isolated output #42.
`OUTPUT_LINE43` Opto-isolated output #43.
`OUTPUT_LINE44` Opto-isolated output #44.
`OUTPUT_LINE45` Opto-isolated output #45.
`OUTPUT_LINE46` Opto-isolated output #46.
`OUTPUT_LINE47` Opto-isolated output #47.
`SAMPLE_ON_EDGE` (ACR90x0 and Aries) Sample on trigger edge (rather than continuously after the first trigger)?
`SAMPLING_ACTIVE` (ACR90x0 and Aries) Is sampling active at the moment?
`SAMPLING_ARMED` (ACR90x0 and Aries) Is the sampling trigger armed?
`SHOW_LINE_NUMBERS` (ACR90x0 and Aries) Print line numbers when listing programs?
`TRIGGER_SOFTWARE_CAPTURE` (ACR90X0 AND Aries) Set this bit then wait for it to go down again for axis positions to go into the Software Capture registers.
`USER_BIT0` User bit 0.
`USER_BIT1` User bit 1.
`USER_BIT10` User bit 10.
`USER_BIT11` User bit 11.
`USER_BIT12` User bit 12.
`USER_BIT13` User bit 13.
`USER_BIT14` User bit 14.
`USER_BIT15` User bit 15.
`USER_BIT2` User bit 2.
`USER_BIT3` User bit 3.
`USER_BIT4` User bit 4.
`USER_BIT5` User bit 5.
`USER_BIT6` User bit 6.
`USER_BIT7` User bit 7.
`USER_BIT8` User bit 8.
`USER_BIT9` User bit 9.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SystemUnsigned`	`flagParameter()` Gets the index of the flag parameter containing this bit.
`long`	`flagParameterMask()` Gets the mask with a single 1 bit in the position assigned to this bit in the associated flag parameter.
`int`	`index()` Gets the bit index used by the motor controller.
`String`	`reference()` Gets the string used to refer to the bit in AcroBasic.
`static SystemBit`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SystemBit[]`	`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, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - INPUT_LINE0
```
public static final SystemBit INPUT_LINE0
```
    Opto-isolated input #0.
  - INPUT_LINE1
```
public static final SystemBit INPUT_LINE1
```
    Opto-isolated input #1.
  - INPUT_LINE2
```
public static final SystemBit INPUT_LINE2
```
    Opto-isolated input #2.
  - INPUT_LINE3
```
public static final SystemBit INPUT_LINE3
```
    Opto-isolated input #3.
  - INPUT_LINE4
```
public static final SystemBit INPUT_LINE4
```
    Opto-isolated input #4.
  - INPUT_LINE5
```
public static final SystemBit INPUT_LINE5
```
    Opto-isolated input #5.
  - INPUT_LINE6
```
public static final SystemBit INPUT_LINE6
```
    Opto-isolated input #6.
  - INPUT_LINE7
```
public static final SystemBit INPUT_LINE7
```
    Opto-isolated input #7.
  - INPUT_LINE8
```
public static final SystemBit INPUT_LINE8
```
    Opto-isolated input #8.
  - INPUT_LINE9
```
public static final SystemBit INPUT_LINE9
```
    Opto-isolated input #9.
  - INPUT_LINE10
```
public static final SystemBit INPUT_LINE10
```
    Opto-isolated input #10.
  - INPUT_LINE11
```
public static final SystemBit INPUT_LINE11
```
    Opto-isolated input #11.
  - INPUT_LINE12
```
public static final SystemBit INPUT_LINE12
```
    Opto-isolated input #12.
  - INPUT_LINE13
```
public static final SystemBit INPUT_LINE13
```
    Opto-isolated input #13.
  - INPUT_LINE14
```
public static final SystemBit INPUT_LINE14
```
    Opto-isolated input #14.
  - INPUT_LINE15
```
public static final SystemBit INPUT_LINE15
```
    Opto-isolated input #15.
  - INPUT_LINE16
```
public static final SystemBit INPUT_LINE16
```
    Opto-isolated input #15.
  - INPUT_LINE17
```
public static final SystemBit INPUT_LINE17
```
    Opto-isolated input #15.
  - INPUT_LINE18
```
public static final SystemBit INPUT_LINE18
```
    Opto-isolated input #15.
  - INPUT_LINE19
```
public static final SystemBit INPUT_LINE19
```
    Opto-isolated input #15.
  - INPUT_LINE20
```
public static final SystemBit INPUT_LINE20
```
    Opto-isolated input #15.
  - INPUT_LINE21
```
public static final SystemBit INPUT_LINE21
```
    Opto-isolated input #15.
  - INPUT_LINE22
```
public static final SystemBit INPUT_LINE22
```
    Opto-isolated input #15.
  - INPUT_LINE23
```
public static final SystemBit INPUT_LINE23
```
    Opto-isolated input #15.
  - INPUT_LINE24
```
public static final SystemBit INPUT_LINE24
```
    Opto-isolated input #15.
  - INPUT_LINE25
```
public static final SystemBit INPUT_LINE25
```
    Opto-isolated input #15.
  - INPUT_LINE26
```
public static final SystemBit INPUT_LINE26
```
    Opto-isolated input #15.
  - INPUT_LINE27
```
public static final SystemBit INPUT_LINE27
```
    Opto-isolated input #15.
  - INPUT_LINE28
```
public static final SystemBit INPUT_LINE28
```
    Opto-isolated input #15.
  - INPUT_LINE29
```
public static final SystemBit INPUT_LINE29
```
    Opto-isolated input #15.
  - INPUT_LINE30
```
public static final SystemBit INPUT_LINE30
```
    Opto-isolated input #15.
  - INPUT_LINE31
```
public static final SystemBit INPUT_LINE31
```
    Opto-isolated input #15.
  - OUTPUT_LINE32
```
public static final SystemBit OUTPUT_LINE32
```
    Opto-isolated output #32.
  - OUTPUT_LINE33
```
public static final SystemBit OUTPUT_LINE33
```
    Opto-isolated output #33.
  - OUTPUT_LINE34
```
public static final SystemBit OUTPUT_LINE34
```
    Opto-isolated output #34.
  - OUTPUT_LINE35
```
public static final SystemBit OUTPUT_LINE35
```
    Opto-isolated output #35.
  - OUTPUT_LINE36
```
public static final SystemBit OUTPUT_LINE36
```
    Opto-isolated output #36.
  - OUTPUT_LINE37
```
public static final SystemBit OUTPUT_LINE37
```
    Opto-isolated output #37.
  - OUTPUT_LINE38
```
public static final SystemBit OUTPUT_LINE38
```
    Opto-isolated output #38.
  - OUTPUT_LINE39
```
public static final SystemBit OUTPUT_LINE39
```
    Opto-isolated output #39.
  - OUTPUT_LINE40
```
public static final SystemBit OUTPUT_LINE40
```
    Opto-isolated output #40.
  - OUTPUT_LINE41
```
public static final SystemBit OUTPUT_LINE41
```
    Opto-isolated output #41.
  - OUTPUT_LINE42
```
public static final SystemBit OUTPUT_LINE42
```
    Opto-isolated output #42.
  - OUTPUT_LINE43
```
public static final SystemBit OUTPUT_LINE43
```
    Opto-isolated output #43.
  - OUTPUT_LINE44
```
public static final SystemBit OUTPUT_LINE44
```
    Opto-isolated output #44.
  - OUTPUT_LINE45
```
public static final SystemBit OUTPUT_LINE45
```
    Opto-isolated output #45.
  - OUTPUT_LINE46
```
public static final SystemBit OUTPUT_LINE46
```
    Opto-isolated output #46.
  - OUTPUT_LINE47
```
public static final SystemBit OUTPUT_LINE47
```
    Opto-isolated output #47.
  - SAMPLING_ARMED
```
public static final SystemBit SAMPLING_ARMED
```
    (ACR90x0 and Aries) Is the sampling trigger armed?
  - SAMPLING_ACTIVE
```
public static final SystemBit SAMPLING_ACTIVE
```
    (ACR90x0 and Aries) Is sampling active at the moment?
  - SAMPLE_ON_EDGE
```
public static final SystemBit SAMPLE_ON_EDGE
```
    (ACR90x0 and Aries) Sample on trigger edge (rather than continuously after the first trigger)?
  - TRIGGER_SOFTWARE_CAPTURE
```
public static final SystemBit TRIGGER_SOFTWARE_CAPTURE
```
    (ACR90X0 AND Aries) Set this bit then wait for it to go down again for axis positions to go into the Software Capture registers. Normally you need encoders for this but the INTCAP command description tells how to use it for stepper motors with no encoders.
  - USER_BIT0
```
public static final SystemBit USER_BIT0
```
    User bit 0.
  - USER_BIT1
```
public static final SystemBit USER_BIT1
```
    User bit 1.
  - USER_BIT2
```
public static final SystemBit USER_BIT2
```
    User bit 2.
  - USER_BIT3
```
public static final SystemBit USER_BIT3
```
    User bit 3.
  - USER_BIT4
```
public static final SystemBit USER_BIT4
```
    User bit 4.
  - USER_BIT5
```
public static final SystemBit USER_BIT5
```
    User bit 5.
  - USER_BIT6
```
public static final SystemBit USER_BIT6
```
    User bit 6.
  - USER_BIT7
```
public static final SystemBit USER_BIT7
```
    User bit 7.
  - USER_BIT8
```
public static final SystemBit USER_BIT8
```
    User bit 8.
  - USER_BIT9
```
public static final SystemBit USER_BIT9
```
    User bit 9.
  - USER_BIT10
```
public static final SystemBit USER_BIT10
```
    User bit 10.
  - USER_BIT11
```
public static final SystemBit USER_BIT11
```
    User bit 11.
  - USER_BIT12
```
public static final SystemBit USER_BIT12
```
    User bit 12.
  - USER_BIT13
```
public static final SystemBit USER_BIT13
```
    User bit 13.
  - USER_BIT14
```
public static final SystemBit USER_BIT14
```
    User bit 14.
  - USER_BIT15
```
public static final SystemBit USER_BIT15
```
    User bit 15.
  - SHOW_LINE_NUMBERS
```
public static final SystemBit SHOW_LINE_NUMBERS
```
    (ACR90x0 and Aries) Print line numbers when listing programs?
  - LATCHED_MOTION_DISABLE
```
public static final SystemBit LATCHED_MOTION_DISABLE
```
    (ACR9000) Turns on when the Motion Enable input loses voltage and remains on until the CLEAR_LATCHED_MOTION_DISABLE bit is set.
  - MOTION_DISABLE
```
public static final SystemBit MOTION_DISABLE
```
    (ACR9000) Indicates that the Motion Enable currently has no voltage (is open).
  - CLEAR_LATCHED_MOTION_DISABLE
```
public static final SystemBit CLEAR_LATCHED_MOTION_DISABLE
```
    (ACR9000) Set this bit to clear a latched motion disable, assuming that the Motion Enable input has voltage again.
- Method Detail
  - values
```
public static SystemBit[] 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 (SystemBit c : SystemBit.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SystemBit 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
  - index
```
public int index()
```
    Gets the bit index used by the motor controller.
    
    Returns:
    
    the index.
  - reference
```
public String reference()
```
    Gets the string used to refer to the bit in AcroBasic.
    
    Returns:
    
    the reference string.
  - flagParameter
```
public SystemUnsigned flagParameter()
```
    Gets the index of the flag parameter containing this bit.
    
    Returns:
    
    the index.
  - flagParameterMask
```
public long flagParameterMask()
```
    Gets the mask with a single 1 bit in the position assigned to this bit in the associated flag parameter.
    
    Returns:
    
    the mask.

Enum SystemBit

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INPUT_LINE0

INPUT_LINE1

INPUT_LINE2

INPUT_LINE3

INPUT_LINE4

INPUT_LINE5

INPUT_LINE6

INPUT_LINE7

INPUT_LINE8

INPUT_LINE9

INPUT_LINE10

INPUT_LINE11

INPUT_LINE12

INPUT_LINE13

INPUT_LINE14

INPUT_LINE15

INPUT_LINE16

INPUT_LINE17

INPUT_LINE18

INPUT_LINE19

INPUT_LINE20

INPUT_LINE21

INPUT_LINE22

INPUT_LINE23

INPUT_LINE24

INPUT_LINE25

INPUT_LINE26

INPUT_LINE27

INPUT_LINE28

INPUT_LINE29

INPUT_LINE30

INPUT_LINE31

OUTPUT_LINE32

OUTPUT_LINE33

OUTPUT_LINE34

OUTPUT_LINE35

OUTPUT_LINE36

OUTPUT_LINE37

OUTPUT_LINE38

OUTPUT_LINE39

OUTPUT_LINE40

OUTPUT_LINE41

OUTPUT_LINE42

OUTPUT_LINE43

OUTPUT_LINE44

OUTPUT_LINE45

OUTPUT_LINE46

OUTPUT_LINE47

SAMPLING_ARMED

SAMPLING_ACTIVE

SAMPLE_ON_EDGE

TRIGGER_SOFTWARE_CAPTURE

USER_BIT0

USER_BIT1

USER_BIT2

USER_BIT3

USER_BIT4

USER_BIT5

USER_BIT6

USER_BIT7

USER_BIT8

USER_BIT9

USER_BIT10

USER_BIT11

USER_BIT12

USER_BIT13

USER_BIT14

USER_BIT15

SHOW_LINE_NUMBERS

LATCHED_MOTION_DISABLE

MOTION_DISABLE

CLEAR_LATCHED_MOTION_DISABLE

Method Detail

values