Component: IButton (DS1990) (Storage)

Author	MatrixTSL
Version	1.0
Category	Storage

IButton (DS1990) component

A rugged 48-bit unique identifier allowing for unique codes for logistical tracking or device identifiers etc. Compatible with the DS1990A and DS1990R iButton devices. Requires a One Wire component to perform the bus operations.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	GetSerialString
Gets the Serial String for the current addressed device.
- STRING	Return

	AddressNextDevice
Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro.
- VOID	Return

	Initialise
Configures each matching sensor on the bus with the specified conversion bits.
- VOID	Return

	GetSerialString
Gets the Serial String for the current addressed device.
- STRING	Return

	AddressNextDevice
Scans for the next connected device with a matching family code. Goes through the device list generated by the ScanBus macro.
- VOID	Return

	SetLong
Writes a 32-bit value to the EE memory. For consecutive 32-bit values the address must be incremented by 4.
- UINT	Address
Address of the value to write
- ULONG	Value
32-bit value to write
[[File:]] -	MSBFirst
0: LSB is the first byte, 1: MSB is the first byte
- VOID	Return

	GetFloat
Reads a 32-bit floating point value starting from the specified byte address. For consecutive float values the address must be incremented by 4.
[[File:]] -	Address
The starting byte address
[[File:]] -	MSBFirst
0: LSB is the first byte, 1: MSB is the first byte
[[File:]] -	Return

	GetLong
Reads a 32-bit value starting from the specified byte address. For consecutive 32-bit values the address must be incremented by 4.
[[File:]] -	Address
The starting byte address
[[File:]] -	MSBFirst
0: LSB is the first byte, 1: MSB is the first byte
- ULONG	Return

	GetInt
Reads a 16-bit value starting from the specified byte address. For consecutive 16-bit values the address must be incremented by 2.
[[File:]] -	Address
The starting byte address
[[File:]] -	MSBFirst
0: LSB is the first byte, 1: MSB is the first byte
- UINT	Return

	GetByteArray
Reads an array of bytes starting from the selected address.
- UINT	Address
Starting address of the first value to read
- BYTE	Data
Byte array to store incoming data
- UINT	Count
Number of bytes to read from the EE memory, Range: 1 to 128 bytes
- VOID	Return

	SetByte
Writes a single byte to the EE memory.
- UINT	Address
Address of the value to write
- BYTE	Data
- VOID	Return

	GetByte
Reads a single byte from the selected address.
- UINT	Address
Address of the value to read
- BYTE	Return

	SetFloat
Writes a 32-bit floating point value to the EE memory. For consecutive float values the address must be incremented by 4.
- UINT	Address
Address of the value to write
[[File:]] -	Value
Floating point value to write
[[File:]] -	MSBFirst
0: LSB is the first byte, 1: MSB is the first byte
- VOID	Return

	Initialise
Configures each matching sensor on the bus with the specified conversion bits.
- VOID	Return

	SendBinaryFloat
Sends out a 32-bit binary floating point value split across four bytes.
[[File:]] -	Value
[[File:]] -	MSBfirst
0=Least significant byte first, 1=Most significant byte first
- VOID	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

	ReceiveByteArray
Attempts to receive an array of bytes using the COM port Returns the number of bytes received.
- BYTE	Data
- UINT	MaxLength
Max number of bytes to try and read
- UINT	Timeout
Time to wait for incoming data in milliseconds
- UINT	Return

	ReceiveString
Attempts to receive an string using the COM port Returns the number of bytes received.
- UINT	Timeout
Time to wait for incoming data in milliseconds
- UINT	MaxLength
Max number of bytes to try and read
- STRING	Return

	PWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
- BYTE	EnableMask
Range 0-63 or 0b00000 to 0b111111
- VOID	Return

	Initialise
- VOID	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

Property reference

	Properties
	One Wire Component
Link to the one wire component to host the bus.
	Number Devices
Sens the number of sensors we can communicate with during simulation
	Serial 0
Serial number for simulated one wire device
	Connections
	Simulations
	Simulate Comms
No - We use the panel GUI to perform the simulation. Yes - We use OneWire comms via an API to communicate with real hardware.