sm16univin 1.1.0

Library to control Sixteen Analog/Digital Inputs 8-Layer Stackable HAT for Raspberry Pi

Welcome to lib16univin’s documentation!

Install

sudo pip install SM16univin

or

sudo pip3 install SM16univin

Update

sudo pip install SM16univin -U

or

sudo pip3 install SM16univin -U

Initiate class

$ python
Python 3.9.2 (default, Feb 28 2021, 17:03:44)
[GCC 10.2.1 20210110] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import lib16univin
>>> card = lib16univin.SM16univin()
>>> card.get_version()
>>>

Documentation

class lib16univin.SM16univin(stack=0, i2c=1)

Bases: object

Python class to control the 16 Universal Analog Inputs Card for Raspberry Pi.

• Parameters:
  • stack (int) – Stack level/device number.
  • i2c (int) – i2c bus number

cfg_input_type(channel, input_type)

Configure the input type for a channel. Available on cards version 3.0 and later. On older cards the input type is set via hardware jumpers and cannot be changed in software. Cards V3+ also introduce the 4-20mA and 0-3.3V input types, in addition to the existing 0-10V and thermistor types. Voltage and current types (0-10V, 4-20mA, 0-3.3V) can be read using get_in(); thermistor types use get_r1k_in() or get_r10k_in().

The available input types are: : “0_10V”: 0-10V voltage input “r1k”: 1k thermistor input “r10k”: 10k thermistor input “4_20mA”: 4-20mA current input “0_3V3”: 0-3.3V voltage input

• Parameters:
  • channel (int) – Channel number
  • input_type (str) – Input type. Must be “0_10V”, “r1k”, “r10k”, “4_20mA” or “0_3V3”

get_all_dig_in()

Get all digital (dry contact) input status as a bitmask.

• Returns: (int) Optocoupled bitmask

get_all_leds()

Get all leds state as bitmask.

• Returns: (int) Leds state bitmask

get_button()

Get button status.

• Returns: (bool) status : True(ON)/False(OFF)

get_button_latch()

Get button latch status.

• Returns: (bool) status : True(ON)/False(OFF)

get_dig_in(channel)

Get digital (dry contact) input status.

• Parameters: channel (int) – Channel number
• Returns: (bool) Channel status

get_dig_in_cnt_en(channel)

Get digital (dry contact) input counting edges status.

• Parameters: channel (int) – Channel number
• Returns: (int) Counting edge status : 0(disable)/1(enable)

get_dig_in_counter(channel)

Get digital (dry contact) inputs edges counter for one channel.

• Parameters: channel (int) – Channel number
• Returns: (int) dry contact transitions counter

get_in(channel)

Read the input channel value. Available on cards version 3.0 and later. On V3+ cards, the input type is software-configurable per channel using cfg_input_type(). All three electrical types (0-10V, 4-20mA and 0-3.3V) share the same register, so the unit of the returned value depends on the configured type: volts for 0-10V and 0-3.3V, milliamps for 4-20mA. For 1k or 10k thermistor configurations, use get_r1k_in() or get_r10k_in() instead, which return resistance in ohms.

• Parameters: channel (int) – Channel number
• Returns: (float) Input channel value in volts (0-10V, 0-3.3V) or milliamps (4-20mA)

get_input_type(channel)

Get the configured input type for a channel. Available on cards version 3.0 and later.

• Parameters: channel (int) – Channel number
• Returns: “0_10V”, “r1k”, “r10k”, “4_20mA” or “0_3V3”
• Return type: (str) Configured input type

get_led(led)

Get led state.

• Parameters: led (int) – Led number
• Returns: (int) Led state

get_r10k_in(channel)

Get 10k thermistor input channel value in ohms.

• Parameters: channel (int) – Channel number
• Returns: (int) Input value in ohms

get_r1k_in(channel)

Get 1k thermistor input channel value in ohms.

• Parameters: channel (int) – Channel number
• Returns: (int) Input value in ohms

get_rtc()

Get rtc time.

• Returns: (tuple) date(year, month, day, hour, minute, second)

get_u_in(channel)

For cards prior to version 3.0. On version 3.0 and later, prefer get_in(), which reflects the configured input type. Get 0-10V input channel value in volts.

• Parameters: channel (int) – Channel number
• Returns: (float) Input channel value in volts

get_version()

Get firmware version.

Returns: (int) Firmware version number

reset_dig_in_counter(channel)

Reset optocoupled inputs edges counter.

• Parameters: channel (int) – Channel number

set_all_leds(val)

Set all leds states as bitmask.

• Parameters: val (int) – Leds bitmask

set_dig_in_cnt_en(channel, value)

Set digital (dry contact) input channel counting edges status.

• Parameters:
  • channel (int) – Channel number
  • value (int) – Counting edge status 0(disable)/1(enable)

set_led(led, val)

Set led state.

• Parameters:
  • led (int) – Led number
  • val – 0(OFF) or 1(ON)

set_rtc(year, month, day, hour, minute, second)

Set rtc time.

• Parameters:
  • year (int) – current year
  • month (int) – current month
  • day (int) – current day
  • hour (int) – current hour
  • minute (int) – current minute
  • second (int) – current second

wdt_clear_reset_count()

Clear watchdog counter.

wdt_get_init_period()

Get watchdog initial period.

• Returns: (int) Initial watchdog period in seconds

wdt_get_off_period()

Get watchdog off period in seconds.

• Returns: (int) Watchfog off period in seconds.

wdt_get_period()

Get watchdog period in seconds.

• Returns: (int) Watchdog period in seconds

wdt_get_reset_count()

Get watchdog reset count.

• Returns: (int) Watchdog reset count

wdt_reload()

Reload watchdog.

wdt_set_init_period(period)

Set watchdog initial period.

• Parameters: period (int) – Initial period in second

wdt_set_off_period(period)

Set off period in seconds

• Parameters: period (int) – Off period in seconds

wdt_set_period(period)

Set watchdog period.

• Parameters: period (int) – Channel number