public class BrickletOneWire extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletOneWire.Read |
class |
BrickletOneWire.SearchBus |
class |
BrickletOneWire.SearchBusLowLevel |
class |
BrickletOneWire.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletOneWire(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
int |
getCommunicationLEDConfig()
Returns the configuration as set by
setCommunicationLEDConfig(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.
|
BrickletOneWire.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
BrickletOneWire.Read |
read()
Reads a byte of data from the 1-Wire bus.
|
long |
readUID()
Returns the current UID as an integer.
|
void |
reset()
Calling this function will reset the Bricklet.
|
int |
resetBus()
Resets the bus with the 1-Wire reset operation.
|
BrickletOneWire.SearchBus |
searchBus()
Returns a list of up to 64 identifiers of the connected 1-Wire devices.
|
BrickletOneWire.SearchBusLowLevel |
searchBusLowLevel()
Returns a list of up to 64 identifiers of the connected 1-Wire devices.
|
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setCommunicationLEDConfig(int config)
Sets the communication LED configuration.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
write(int data)
Writes a byte of data to the 1-Wire bus.
|
int |
writeCommand(long identifier,
int command)
Writes a command to the 1-Wire device with the given identifier.
|
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_SEARCH_BUS_LOW_LEVEL
public static final byte FUNCTION_RESET_BUS
public static final byte FUNCTION_WRITE
public static final byte FUNCTION_READ
public static final byte FUNCTION_WRITE_COMMAND
public static final byte FUNCTION_SET_COMMUNICATION_LED_CONFIG
public static final byte FUNCTION_GET_COMMUNICATION_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 STATUS_OK
public static final int STATUS_BUSY
public static final int STATUS_NO_PRESENCE
public static final int STATUS_TIMEOUT
public static final int STATUS_ERROR
public static final int COMMUNICATION_LED_CONFIG_OFF
public static final int COMMUNICATION_LED_CONFIG_ON
public static final int COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT
public static final int COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION
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 BrickletOneWire(String uid, IPConnection ipcon)
public BrickletOneWire.SearchBusLowLevel searchBusLowLevel() throws TinkerforgeException
TinkerforgeException
public int resetBus() throws TinkerforgeException
TinkerforgeException
public int write(int data) throws TinkerforgeException
TinkerforgeException
public BrickletOneWire.Read read() throws TinkerforgeException
TinkerforgeException
public int writeCommand(long identifier, int command) throws TinkerforgeException
searchBus()
. The MATCH ROM operation is used to
write the command.
If you only have one device connected or want to broadcast to all devices
you can set the identifier to 0. In this case the SKIP ROM operation is used to
write the command.TinkerforgeException
public void setCommunicationLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getCommunicationLEDConfig() throws TinkerforgeException
setCommunicationLEDConfig(int)
TinkerforgeException
public BrickletOneWire.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 BrickletOneWire.SearchBus searchBus() throws TinkerforgeException
TinkerforgeException
Copyright © 2021 Tinkerforge GmbH. All rights reserved.