Toit
Libraries
bignum
binary
bitmap
ble
bytes
core
crypto
device
encoding
esp32
expect
fixed-point
flash
font
gpio
i2c
i2s
icons
io
line-wrap
log
math
monitor
net
pulse-counter
reader
reader-writer
rmt
serial
spi
statistics
system
tls
uart
uuid
writer
zlib

Class Registers

extends Registers
Register description of a device connected to an SPI bus.

Class summary

constructor device_/Device
Deprecated. Use Device.registers.

Constructors

constructor device_/Device
Deprecated. Use Device.registers.

Methods

dump --from/any=128 --to/any=256 --width/any=8 -> none
Prints register values.
Prints registers starting at the given from until the given to (exclusive) as hexadecimal digits.
The width indicates the amount of bytes per line.
operator == other/any -> bool
Whether this object is equal to the other.
By default, identical is used for equality.
Inheritance
Classes overwrite this operator to get an equality specific to their needs. Equality operators often compare the type and field contents. For example:

class Pin:
  number/int

  constructor .number:

  operator == other:
    if other is not Pin: return false
    return number == other.number
A class doesn't have to follow the above format, but it must keep the operator in sync with any hash-code method. That is, if a class has a hash-code member, then the equality and hash-code must agree. If two instances are equal (a == b), then their hash codes must also be equal (a.hash-code == b.hash-code).
read-bytes register/int count/int -> any
See super.
If msb-write is set (see set-msb-write) modifies the register value so it has a low most-significant bit.
read-bytes reg/any count/any [failure] -> ByteArray
Variant of read-bytes register count
Calls the failure block in case of an exception.
Deprecated. Use exception handling instead.
read-i16-be register/int -> int
Reads a signed 16-bit integer from the register.
Uses big endian.
read-i16-le register/int -> int
Reads a signed 16-bit integer from the register.
Uses little endian.
read-i24-be register/int -> int
Reads a signed 24-bit integer from the register.
Uses big endian.
read-i24-le register/int -> int
Reads a signed 24-bit integer from the register.
Uses little endian.
read-i32-be register/int -> int
Reads a signed 32-bit integer from the register.
Uses big endian.
read-i32-le register/int -> int
Reads a signed 32-bit integer from the register.
Uses little endian.
read-i8 register/int -> int
Reads a signed 8-bit integer from the register.
read-u16-be register/int -> int
Reads an unsigned 16-bit integer from the register.
Uses big endian.
read-u16-be register/int [failure] -> int
Reads an unsigned 16-bit integer from the register.
Uses little endian.
Calls the failure block in case of an exception.
Deprecated. Use exception handling instead.
read-u16-le register/int -> int
Reads an unsigned 16-bit integer from the register.
Uses little endian.
read-u24-be register/int -> int
Reads an unsigned 24-bit integer from the register.
Uses big endian.
read-u24-le register/int -> int
Reads an unsigned 24-bit integer from the register.
Uses little endian.
read-u32-be register/int -> int
Reads an unsigned 32-bit integer from the register.
Uses big endian.
read-u32-le register/int -> int
Reads an unsigned 32-bit integer from the register.
Uses little endian.
read-u8 register/int -> int
Reads an unsigned 8-bit integer from the register.
set-msb-write value/bool -> none
Sets the writing mode.
If set to true, then emits a high most-significant bit (msb) for writes, and a low most-significant bit for reads. Generally, this modifies the register value that is sent as first byte on the bus.
If set to false, then it does the opposite: writes emit a low msb, and reads start with a high msb.
The default is false.
stringify -> string
Stringifies this object.
Inheritance
Objects that need a human-friendly string representation should overwrite this method. The default string is based on the internal class-ID.
write-32-le register/int value/int -> none
Writes the value to the given register as a signed 32-bit integer.
Uses little endian.
write-bytes reg/int bytes/ByteArray -> none
See super.
If msb-write is set (see set-msb-write) modifies the register value so it has a high most-significant bit.
write-i16-be register/int value/int -> none
Writes the value to the given register as a signed 16-bit integer.
Uses big endian.
write-i16-le register/int value/int -> none
Writes the value to the given register as a signed 16-bit integer.
Uses little endian.
write-i24-be register/int value/int -> none
Writes the value to the given register as a signed 24-bit integer.
Uses big endian.
write-i24-le register/int value/int -> none
Writes the value to the given register as a signed 24-bit integer.
Uses little endian.
write-i32-be register/int value/int -> none
Writes the value to the given register as an unsigned 32-bit integer.
Uses big endian.
write-i8 register/int value/int -> none
Writes the value to the given register as a signed 8-bit integer.
write-u16-be register/int value/int -> none
Writes the value to the given register as an unsigned 16-bit integer.
Uses big endian.
write-u16-le register/int value/int -> none
Writes the value to the given register as an unsigned 16-bit integer.
Uses little endian.
write-u24-be register/int value/int -> none
Writes the value to the given register as an unsigned 24-bit integer.
Uses big endian.
write-u24-le register/int value/int -> none
Writes the value to the given register as an unsigned 24-bit integer.
Uses little endian.
write-u32-le register/int value/int -> none
Writes the value to the given register as an unsigned 32-bit integer.
Uses little endian.
write-u8 register/int value/int -> none
Writes the value to the given register as an unsigned 8-bit integer.