pyupm_relay module

class pyupm_relay.Relay(pin)

Bases: object

API for the Relay.

ID: relay

Name: Relay

Other Names: Grove Relay

Category: relay

Manufacturer: seeed

Connection: gpio

Kit: gsk eak hak UPM module for the relay switch. The relay is a digital normally-open switch that uses low voltage or current to control a higher voltage and/or higher current. When closed, the indicator LED (if present) lights up and current is allowed to flow.

C++ includes: relay.hpp

isOff()

bool isOff()

Defines whether the relay switch is open.

True if the switch is off (open), false otherwise

isOn()

bool isOn()

Defines whether the relay switch is closed.

True if the switch is on (closed), false otherwise

name()

std::string name()

off()

mraa_result_t off()

Sets the relay switch to off (open). This stops current from flowing and the indicator LED is not lit.

0 if successful, non-zero otherwise

on()

mraa_result_t on()

Sets the relay switch to on (closed). This allows current to flow and lights up the indicator LED.

0 if successful, non-zero otherwise