PinBase — gpio | Standard libraries — Toit

Class PinBase

extends Object implements Pin

A base class for pins.

Note that the configure_ method is abstract and must be implemented by subclasses. It is not private but protected.

Class summary

constructor num/int

Constructors

constructor num/int

Methods

close -> any

config --input/bool=false --output/bool=false --open-drain/bool=false -> none

See Pin.config.

configure --input/bool=false --output/bool=false --pull-up/bool=false --pull-down/bool=false --open-drain/bool=false --value/int=null -> none

See Pin.configure.

do [block] -> none

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).

set value/int -> any

set-open-drain value/bool -> any

See Pin.set-open-drain.

set-pull --up/bool=false --down/bool=false --off/bool=false -> any

See Pin.set-pull.

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.

wait-for value/any -> none

See Pin.wait-for.

Fields