public class BrickletIndustrialPTC extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletIndustrialPTC.MovingAverageConfiguration |
class |
BrickletIndustrialPTC.ResistanceCallbackConfiguration |
static interface |
BrickletIndustrialPTC.ResistanceListener
This listener is triggered periodically according to the configuration set by
setResistanceCallbackConfiguration(long, boolean, char, int, int) . |
static interface |
BrickletIndustrialPTC.SensorConnectedListener
This listener is triggered periodically according to the configuration set by
setSensorConnectedCallbackConfiguration(boolean) . |
class |
BrickletIndustrialPTC.SPITFPErrorCount |
class |
BrickletIndustrialPTC.TemperatureCallbackConfiguration |
static interface |
BrickletIndustrialPTC.TemperatureListener
This listener is triggered periodically according to the configuration set by
setTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
Device.Identity
Constructor and Description |
---|
BrickletIndustrialPTC(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addResistanceListener(BrickletIndustrialPTC.ResistanceListener listener)
Adds a Resistance listener.
|
void |
addSensorConnectedListener(BrickletIndustrialPTC.SensorConnectedListener listener)
Adds a SensorConnected listener.
|
void |
addTemperatureListener(BrickletIndustrialPTC.TemperatureListener listener)
Adds a Temperature listener.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
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.
|
BrickletIndustrialPTC.MovingAverageConfiguration |
getMovingAverageConfiguration()
Returns the moving average configuration as set by
setMovingAverageConfiguration(int, int) . |
int |
getNoiseRejectionFilter()
Returns the noise rejection filter option as set by
setNoiseRejectionFilter(int) |
int |
getResistance()
Returns the value as measured by the MAX31865 precision delta-sigma ADC.
|
BrickletIndustrialPTC.ResistanceCallbackConfiguration |
getResistanceCallbackConfiguration()
Returns the listener configuration as set by
setResistanceCallbackConfiguration(long, boolean, char, int, int) . |
boolean |
getSensorConnectedCallbackConfiguration()
Returns the configuration as set by
setSensorConnectedCallbackConfiguration(boolean) . |
BrickletIndustrialPTC.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
int |
getTemperature()
Returns the temperature of the connected sensor.
|
BrickletIndustrialPTC.TemperatureCallbackConfiguration |
getTemperatureCallbackConfiguration()
Returns the listener configuration as set by
setTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
int |
getWireMode()
Returns the wire mode as set by
setWireMode(int) |
boolean |
isSensorConnected()
Returns *true* if the sensor is connected correctly.
|
long |
readUID()
Returns the current UID as an integer.
|
void |
removeResistanceListener(BrickletIndustrialPTC.ResistanceListener listener)
Removes a Resistance listener.
|
void |
removeSensorConnectedListener(BrickletIndustrialPTC.SensorConnectedListener listener)
Removes a SensorConnected listener.
|
void |
removeTemperatureListener(BrickletIndustrialPTC.TemperatureListener listener)
Removes a Temperature listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setMovingAverageConfiguration(int movingAverageLengthResistance,
int movingAverageLengthTemperature)
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
for the resistance and temperature.
|
void |
setNoiseRejectionFilter(int filter)
Sets the noise rejection filter to either 50Hz (0) or 60Hz (1).
|
void |
setResistanceCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletIndustrialPTC.ResistanceListener listener is triggered
periodically. |
void |
setSensorConnectedCallbackConfiguration(boolean enabled)
If you enable this listener, the
BrickletIndustrialPTC.SensorConnectedListener listener is triggered
every time a Pt sensor is connected/disconnected. |
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setTemperatureCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletIndustrialPTC.TemperatureListener listener is triggered
periodically. |
void |
setWireMode(int mode)
Sets the wire mode of the sensor.
|
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 String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_TEMPERATURE
public static final byte FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_RESISTANCE
public static final byte FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_RESISTANCE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_NOISE_REJECTION_FILTER
public static final byte FUNCTION_GET_NOISE_REJECTION_FILTER
public static final byte FUNCTION_IS_SENSOR_CONNECTED
public static final byte FUNCTION_SET_WIRE_MODE
public static final byte FUNCTION_GET_WIRE_MODE
public static final byte FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION
public static final byte FUNCTION_GET_MOVING_AVERAGE_CONFIGURATION
public static final byte FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION
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 char THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_GREATER
public static final int FILTER_OPTION_50HZ
public static final int FILTER_OPTION_60HZ
public static final int WIRE_MODE_2
public static final int WIRE_MODE_3
public static final int WIRE_MODE_4
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 BrickletIndustrialPTC(String uid, IPConnection ipcon)
public int getTemperature() throws TinkerforgeException
BrickletIndustrialPTC.TemperatureListener
listener. You can set the listener configuration
with setTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletIndustrialPTC.TemperatureListener
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.
It is furthermore possible to constrain the listener with thresholds.
The `option`-parameter together with min/max sets a threshold for the BrickletIndustrialPTC.TemperatureListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Threshold is turned off"
"'o'", "Threshold is triggered when the value is *outside* the min and max values"
"'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values"
"'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)"
"'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
\endverbatim
If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.TinkerforgeException
public BrickletIndustrialPTC.TemperatureCallbackConfiguration getTemperatureCallbackConfiguration() throws TinkerforgeException
setTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public int getResistance() throws TinkerforgeException
BrickletIndustrialPTC.ResistanceListener
listener. You can set the listener configuration
with setResistanceCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setResistanceCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletIndustrialPTC.ResistanceListener
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.
It is furthermore possible to constrain the listener with thresholds.
The `option`-parameter together with min/max sets a threshold for the BrickletIndustrialPTC.ResistanceListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Threshold is turned off"
"'o'", "Threshold is triggered when the value is *outside* the min and max values"
"'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values"
"'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)"
"'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)"
\endverbatim
If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.TinkerforgeException
public BrickletIndustrialPTC.ResistanceCallbackConfiguration getResistanceCallbackConfiguration() throws TinkerforgeException
setResistanceCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setNoiseRejectionFilter(int filter) throws TinkerforgeException
TinkerforgeException
public int getNoiseRejectionFilter() throws TinkerforgeException
setNoiseRejectionFilter(int)
TinkerforgeException
public boolean isSensorConnected() throws TinkerforgeException
BrickletIndustrialPTC.SensorConnectedListener
listener. You can set the listener configuration
with setSensorConnectedCallbackConfiguration(boolean)
.TinkerforgeException
public void setWireMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getWireMode() throws TinkerforgeException
setWireMode(int)
TinkerforgeException
public void setMovingAverageConfiguration(int movingAverageLengthResistance, int movingAverageLengthTemperature) throws TinkerforgeException
TinkerforgeException
public BrickletIndustrialPTC.MovingAverageConfiguration getMovingAverageConfiguration() throws TinkerforgeException
setMovingAverageConfiguration(int, int)
.TinkerforgeException
public void setSensorConnectedCallbackConfiguration(boolean enabled) throws TinkerforgeException
BrickletIndustrialPTC.SensorConnectedListener
listener is triggered
every time a Pt sensor is connected/disconnected.TinkerforgeException
public boolean getSensorConnectedCallbackConfiguration() throws TinkerforgeException
setSensorConnectedCallbackConfiguration(boolean)
.TinkerforgeException
public BrickletIndustrialPTC.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 addTemperatureListener(BrickletIndustrialPTC.TemperatureListener listener)
public void removeTemperatureListener(BrickletIndustrialPTC.TemperatureListener listener)
public void addResistanceListener(BrickletIndustrialPTC.ResistanceListener listener)
public void removeResistanceListener(BrickletIndustrialPTC.ResistanceListener listener)
public void addSensorConnectedListener(BrickletIndustrialPTC.SensorConnectedListener listener)
public void removeSensorConnectedListener(BrickletIndustrialPTC.SensorConnectedListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.