Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UltrasonicSensor

LEGO EV3 ultrasonic sensor.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _deviceIndex

_deviceIndex: number

connected

connected: boolean

deviceDirName

deviceDirName: string

Protected deviceIndexRegex

deviceIndexRegex: RegExp

deviceRoot

deviceRoot: string

Static overrideSysClassDir

overrideSysClassDir: string

Accessors

address

  • get address(): string

  • Returns the name of the port that the sensor is connected to, e.g. ev3:in1. I2C sensors also include the I2C address (decimal), e.g. ev3:in1:i2c8.

    Returns string

command

  • set command(value: string): void

commands

  • get commands(): string[]

  • Returns a list of the valid commands for the sensor. Returns -EOPNOTSUPP if no commands are supported.

    Returns string[]

decimals

  • get decimals(): number

  • Returns the number of decimal places for the values in the value<N> attributes of the current mode.

    Returns number

deviceIndex

  • get deviceIndex(): number

distanceCentimeters

  • get distanceCentimeters(): number

  • Measurement of the distance detected by the sensor, in centimeters.

    Returns number

distanceInches

  • get distanceInches(): number

  • Measurement of the distance detected by the sensor, in inches.

    Returns number

driverName

  • get driverName(): string

  • Returns the name of the sensor device/driver. See the list of [supported sensors] for a complete list of drivers.

    Returns string

mode

  • get mode(): string
  • set mode(value: string): void

  • Returns the current mode. Writing one of the values returned by modes sets the sensor to that mode.

    Returns string

  • Returns the current mode. Writing one of the values returned by modes sets the sensor to that mode.

    Parameters

    • value: string

    Returns void

modes

  • get modes(): string[]

numValues

  • get numValues(): number

  • Returns the number of value<N> attributes that will return a valid value for the current mode.

    Returns number

otherSensorPresent

  • get otherSensorPresent(): boolean

  • Value indicating whether another ultrasonic sensor could be heard nearby.

    Returns boolean

units

  • get units(): string

  • Returns the units of the measured value for the current mode. May return empty string

    Returns string

Methods

connect

  • connect(driverName: string, nameConvention?: string, propertyConstraints?: object): void

  • Parameters

    • driverName: string
    • Optional nameConvention: string
    • Optional propertyConstraints: object
      • [propertyName: string]: any

    Returns void

Protected constructPropertyPath

  • constructPropertyPath(property: string, deviceRoot?: string): string

getFloatValue

  • getFloatValue(valueIndex: number): number

getValue

  • getValue(valueIndex: number): number

readNumber

  • readNumber(property: string, deviceRoot?: string): number

  • Parameters

    • property: string
    • Optional deviceRoot: string

    Returns number

readProperty

  • readProperty(property: string, deviceRoot?: string): any

readString

  • readString(property: string, deviceRoot?: string): string

  • Parameters

    • property: string
    • Optional deviceRoot: string

    Returns string

readStringArray

  • readStringArray(property: string, deviceRoot?: string): string[]

readStringArrayAsType

  • readStringArrayAsType<T>(property: string, deviceRoot?: string): T[]

readStringAsType

  • readStringAsType<T>(property: string, deviceRoot?: string): T

readStringSelector

  • readStringSelector(property: string, deviceRoot?: string): string

registerEventCallback

  • registerEventCallback(callbackFunction: function, eventPredicate: function, firstTriggerOnly?: boolean, userCallbackData?: any): void

  • Parameters

    • callbackFunction: function
        • (err?: Error, userData?: any): void

        • Parameters

          • Optional err: Error
          • Optional userData: any

          Returns void

    • eventPredicate: function
        • (userData?: any): boolean

        • Parameters

          • Optional userData: any

          Returns boolean

    • Default value firstTriggerOnly: boolean = false
    • Optional userCallbackData: any

    Returns void

registerEventPromise

  • registerEventPromise(eventPredicate: function, userCallbackData?: any): Promise<any>

  • Parameters

    • eventPredicate: function
        • (userData?: any): boolean

        • Parameters

          • Optional userData: any

          Returns boolean

    • Optional userCallbackData: any

    Returns Promise<any>

set

  • set(propertyDefs: any): void

  • Parameters

    • propertyDefs: any

    Returns void

setNumber

  • setNumber(property: string, value: number): void

setProperty

  • setProperty(property: string, value: any): any

setString

  • setString(property: string, value: string): void

Generated using TypeDoc