pamoja for TypeScript - v0.2.0
    Preparing search index...

    Variable ads1115Const

    ads1115: {
        addressGnd: number;
        addressScl: number;
        addressSda: number;
        addressVdd: number;
        configReset: number;
        dataRate: {
            sps128: number;
            sps16: number;
            sps250: number;
            sps32: number;
            sps475: number;
            sps64: number;
            sps8: number;
            sps860: number;
        };
        mux: {
            ain0Ain1: number;
            ain0Ain3: number;
            ain0Gnd: number;
            ain1Ain3: number;
            ain1Gnd: number;
            ain2Ain3: number;
            ain2Gnd: number;
            ain3Gnd: number;
        };
        pga: {
            fsr0_256: number;
            fsr0_512: number;
            fsr1_024: number;
            fsr2_048: number;
            fsr4_096: number;
            fsr6_144: number;
        };
        register: {
            config: number;
            conversion: number;
            hiThresh: number;
            loThresh: number;
        };
        sim: {
            volts: number;
            part(address: number): hal.WordPart;
            reporting(address: number, pga: number, volts: number): hal.WordPart;
        };
        configBits(config: Ads1115Config): number;
        configFromBits(bits: number): Ads1115Config;
        conversionMicros(dataRate: number): number;
        fullScaleMicrovolts(pga: number): number;
        samplesPerSecond(dataRate: number): number;
        toNanovolts(pga: number, raw: number): number;
        toVolts(pga: number, raw: number): number;
    } = ...

    A TI ADS1115 16-bit analog-to-digital converter.

    Type Declaration

    • addressGnd: number

      The address with ADDR tied to ground.

    • addressScl: number

      The address with ADDR tied to SCL.

    • addressSda: number

      The address with ADDR tied to SDA.

    • addressVdd: number

      The address with ADDR tied to VDD.

    • configReset: number

      The value the configuration register reads after a reset.

    • dataRate: {
          sps128: number;
          sps16: number;
          sps250: number;
          sps32: number;
          sps475: number;
          sps64: number;
          sps8: number;
          sps860: number;
      }

      The data-rate codes, in samples per second.

      • sps128: number

        128 per second, the reset setting.

      • sps16: number

        16 per second.

      • sps250: number

        250 per second.

      • sps32: number

        32 per second.

      • sps475: number

        475 per second.

      • sps64: number

        64 per second.

      • sps8: number

        8 per second.

      • sps860: number

        860 per second.

    • mux: {
          ain0Ain1: number;
          ain0Ain3: number;
          ain0Gnd: number;
          ain1Ain3: number;
          ain1Gnd: number;
          ain2Ain3: number;
          ain2Gnd: number;
          ain3Gnd: number;
      }

      The input multiplexer codes.

      • ain0Ain1: number

        AIN0 against AIN1, the reset setting.

      • ain0Ain3: number

        AIN0 against AIN3.

      • ain0Gnd: number

        AIN0 against ground.

      • ain1Ain3: number

        AIN1 against AIN3.

      • ain1Gnd: number

        AIN1 against ground.

      • ain2Ain3: number

        AIN2 against AIN3.

      • ain2Gnd: number

        AIN2 against ground.

      • ain3Gnd: number

        AIN3 against ground.

    • pga: {
          fsr0_256: number;
          fsr0_512: number;
          fsr1_024: number;
          fsr2_048: number;
          fsr4_096: number;
          fsr6_144: number;
      }

      The gain codes, by the full-scale range each selects.

      • fsr0_256: number

        0.256 V.

      • fsr0_512: number

        0.512 V.

      • fsr1_024: number

        1.024 V.

      • fsr2_048: number

        2.048 V, the reset setting.

      • fsr4_096: number

        4.096 V.

      • fsr6_144: number

        6.144 V either side of zero.

    • register: { config: number; conversion: number; hiThresh: number; loThresh: number }

      The registers the pointer selects.

      • config: number

        Input, gain, mode, data rate, and comparator settings.

      • conversion: number

        The last conversion, two's complement.

      • hiThresh: number

        The comparator's high threshold.

      • loThresh: number

        The comparator's low threshold.

    • sim: {
          volts: number;
          part(address: number): hal.WordPart;
          reporting(address: number, pga: number, volts: number): hal.WordPart;
      }

      An ADS1115 that is not there, for a bus with nothing plugged in. A conversion comes back as a count of the range the gain selects, so reporting takes the same gain a driver is given.

      • volts: number

        The voltage part reports: half a 3.3 V supply.

      • part: function
        • A part reading 1.65 V at the range a driver starts with.

          Parameters

          • address: number

            The address it answers to.

          Returns hal.WordPart

          The part, to put on a simulated bus.

      • reporting: function
        • A part that reads what it is asked to, on the nearest of the 32768 steps either side of zero the range divides into.

          Parameters

          • address: number

            The address it answers to.

          • pga: number

            The gain code the driver converts at.

          • volts: number

            The voltage it reports, held to the range.

          Returns hal.WordPart

          The part, to put on a simulated bus.

    • configBits: function
      • Assembles the 16-bit configuration register value.

        Parameters

        Returns number

        The register value to write, most significant bit first.

    • configFromBits: function
      • Parses a 16-bit configuration register value.

        Parameters

        • bits: number

          The register value, as read from the device.

        Returns Ads1115Config

        The decoded settings. Every value decodes, so this never throws.

    • conversionMicros: function
      • Returns how long a conversion takes at a data rate: one period plus the datasheet's ten percent rate variation.

        Parameters

        Returns number

        The time in microseconds.

    • fullScaleMicrovolts: function
      • Returns the full-scale range a gain code selects.

        Parameters

        • pga: number

          The gain code, 0 to 7.

        Returns number

        The full scale in microvolts.

    • samplesPerSecond: function
      • Returns the sample rate a data-rate code selects.

        Parameters

        • dataRate: number

          The data-rate code, 0 to 7.

        Returns number

        The rate in samples per second.

    • toNanovolts: function
      • Converts a raw conversion result to nanovolts.

        Parameters

        • pga: number

          The gain the conversion was taken at.

        • raw: number

          The signed conversion register value.

        Returns number

        The measured voltage, exact at every gain setting.

    • toVolts: function
      • Converts a raw conversion result to volts.

        Parameters

        • pga: number

          The gain the conversion was taken at.

        • raw: number

          The signed conversion register value.

        Returns number

        The measured voltage.