public class BrickletIndustrialDigitalIn4V2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletIndustrialDigitalIn4V2.AllValueCallbackConfiguration |
static interface |
BrickletIndustrialDigitalIn4V2.AllValueListener
This listener is triggered periodically according to the configuration set by
setAllValueCallbackConfiguration(long, boolean) . |
class |
BrickletIndustrialDigitalIn4V2.EdgeCountConfiguration |
class |
BrickletIndustrialDigitalIn4V2.SPITFPErrorCount |
class |
BrickletIndustrialDigitalIn4V2.ValueCallbackConfiguration |
static interface |
BrickletIndustrialDigitalIn4V2.ValueListener
This listener is triggered periodically according to the configuration set by
setValueCallbackConfiguration(int, long, boolean) . |
Device.Identity
Constructor and Description |
---|
BrickletIndustrialDigitalIn4V2(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addAllValueListener(BrickletIndustrialDigitalIn4V2.AllValueListener listener)
Adds a AllValue listener.
|
void |
addValueListener(BrickletIndustrialDigitalIn4V2.ValueListener listener)
Adds a Value listener.
|
BrickletIndustrialDigitalIn4V2.AllValueCallbackConfiguration |
getAllValueCallbackConfiguration()
Returns the listener configuration as set by
setAllValueCallbackConfiguration(long, boolean) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChannelLEDConfig(int channel)
Returns the channel LED configuration as set by
setChannelLEDConfig(int, int) |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
long |
getEdgeCount(int channel,
boolean resetCounter)
Returns the current value of the edge counter for the selected channel.
|
BrickletIndustrialDigitalIn4V2.EdgeCountConfiguration |
getEdgeCountConfiguration(int channel)
Returns the edge type and debounce time for the selected channel as set by
setEdgeCountConfiguration(int, int, int) . |
Device.Identity |
getIdentity()
Returns the UID, the UID where the Bricklet is connected to,
the position, the hardware and firmware version as well as the
device identifier.
|
BrickletIndustrialDigitalIn4V2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
boolean[] |
getValue()
Returns the input value as bools, *true* refers to high and *false* refers to low.
|
BrickletIndustrialDigitalIn4V2.ValueCallbackConfiguration |
getValueCallbackConfiguration(int channel)
Returns the listener configuration for the given channel as set by
setValueCallbackConfiguration(int, long, boolean) . |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeAllValueListener(BrickletIndustrialDigitalIn4V2.AllValueListener listener)
Removes a AllValue listener.
|
void |
removeValueListener(BrickletIndustrialDigitalIn4V2.ValueListener listener)
Removes a Value listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
void |
setAllValueCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletIndustrialDigitalIn4V2.AllValueListener
listener is triggered periodically. |
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setChannelLEDConfig(int channel,
int config)
Each channel has a corresponding LED.
|
void |
setEdgeCountConfiguration(int channel,
int edgeType,
int debounce)
Configures the edge counter for a specific channel.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setValueCallbackConfiguration(int channel,
long period,
boolean valueHasToChange)
This listener can be configured per channel.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_VALUE
public static final byte FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_VALUE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ALL_VALUE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_EDGE_COUNT
public static final byte FUNCTION_SET_EDGE_COUNT_CONFIGURATION
public static final byte FUNCTION_GET_EDGE_COUNT_CONFIGURATION
public static final byte FUNCTION_SET_CHANNEL_LED_CONFIG
public static final byte FUNCTION_GET_CHANNEL_LED_CONFIG
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int CHANNEL_0
public static final int CHANNEL_1
public static final int CHANNEL_2
public static final int CHANNEL_3
public static final int EDGE_TYPE_RISING
public static final int EDGE_TYPE_FALLING
public static final int EDGE_TYPE_BOTH
public static final int CHANNEL_LED_CONFIG_OFF
public static final int CHANNEL_LED_CONFIG_ON
public static final int CHANNEL_LED_CONFIG_SHOW_HEARTBEAT
public static final int CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletIndustrialDigitalIn4V2(java.lang.String uid, IPConnection ipcon)
public boolean[] getValue() throws TinkerforgeException
TinkerforgeException
public void setValueCallbackConfiguration(int channel, long period, boolean valueHasToChange) throws TinkerforgeException
BrickletIndustrialDigitalIn4V2.ValueListener
listener is triggered periodically. A value of 0 turns the listener off.
If the `value has to change`-parameter is set to true, the listener is only
triggered after the value has changed. If the value didn't change within the
period, the listener is triggered immediately on change.
If it is set to false, the listener is continuously triggered with the period,
independent of the value.TinkerforgeException
public BrickletIndustrialDigitalIn4V2.ValueCallbackConfiguration getValueCallbackConfiguration(int channel) throws TinkerforgeException
setValueCallbackConfiguration(int, long, boolean)
.TinkerforgeException
public void setAllValueCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletIndustrialDigitalIn4V2.AllValueListener
listener is triggered periodically. A value of 0 turns the listener off.
If the `value has to change`-parameter is set to true, the listener is only
triggered after the value has changed. If the value didn't change within the
period, the listener is triggered immediately on change.
If it is set to false, the listener is continuously triggered with the period,
independent of the value.TinkerforgeException
public BrickletIndustrialDigitalIn4V2.AllValueCallbackConfiguration getAllValueCallbackConfiguration() throws TinkerforgeException
setAllValueCallbackConfiguration(long, boolean)
.TinkerforgeException
public long getEdgeCount(int channel, boolean resetCounter) throws TinkerforgeException
setEdgeCountConfiguration(int, int, int)
.
If you set the reset counter to *true*, the count is set back to 0
directly after it is read.TinkerforgeException
public void setEdgeCountConfiguration(int channel, int edgeType, int debounce) throws TinkerforgeException
TinkerforgeException
public BrickletIndustrialDigitalIn4V2.EdgeCountConfiguration getEdgeCountConfiguration(int channel) throws TinkerforgeException
setEdgeCountConfiguration(int, int, int)
.TinkerforgeException
public void setChannelLEDConfig(int channel, int config) throws TinkerforgeException
TinkerforgeException
public int getChannelLEDConfig(int channel) throws TinkerforgeException
setChannelLEDConfig(int, int)
TinkerforgeException
public BrickletIndustrialDigitalIn4V2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(int[])
. The pointer has
to be increased by chunks of size 64. The data is written to flash
every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be
necessary to call it in a normal user program.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(long)
before. The firmware is written
to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be
necessary to call it in a normal user program.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addValueListener(BrickletIndustrialDigitalIn4V2.ValueListener listener)
public void removeValueListener(BrickletIndustrialDigitalIn4V2.ValueListener listener)
public void addAllValueListener(BrickletIndustrialDigitalIn4V2.AllValueListener listener)
public void removeAllValueListener(BrickletIndustrialDigitalIn4V2.AllValueListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.