Board BEHAVIOR for OPEN-CLOSE SENSE PAL OPEN-CLOSE SENSE PAL.

void setup() {
  auto&& brd = the_twelite.board.use<PAL_MAG>();
}

The sensor of the open/close sensor pal is a magnetic sensor, which is the only input for the interrupt of the two signal lines.

const uint8_t PAL_MAG::PIN_SNS_NORTH = 16;
const uint8_t PAL_MAG::PIN_SNS_OUT1 = 16;
const uint8_t PAL_MAG::PIN_SNS_SOUTH = 17;
const uint8_t PAL_MAG::PIN_SNS_OUT2 = 17;

PAL_MAG::PIN_NSNSNS_NORTH is interrupted when the sensor detects an N-pole and PAL_MAG::PIN_NSNSNS_SOUTH is interrupted when the sensor detects an N-pole.

The following settings should be made before sleep

pinMode(PAL_MAG::PIN_SNS_OUT1, PIN_MODE::WAKE_FALLING);
pinMode(PAL_MAG::PIN_SNS_OUT2, PIN_MODE::WAKE_FALLING);

Check the IO of the waking factor upon waking.

uint8_t b_north = 
  the_twelite.is_wokeup_by_dio(PAL_MAG::PIN_SNS_NORTH);
uint8_t b_south = 
  the_twelite.is_wokeup_by_dio(PAL_MAG::PIN_SNS_SOUTH);

Board BEHAVIOR for MOTION SENSE PAL MOTION SENSE PAL.

In addition to common definitions, it can handle sensors on the board.

• Accelerometer MC3630

void setup() {
  auto&& brd = the_twelite.board.use<PAL_MOT>();
}

Member Objects

sns_MC3630

MC3630 Sensor object.

Board BEHAVIOR for Environmental Sensor Pal AMBIENT SENSE PAL.

Common Definition plus the sensors on the board can be handled.

• Temperature/humidity sensor SHTC3

• Illuminance sensor LTR308ALS

void setup() {
  auto&& brd = the_twelite.board.use<PAL_AMB>();
}

member object

sns_SHTC3

SHTC3 sensor object.

sns_LTR308ALS

LTR308ALS sensor object.

Board BEHAVIOR for NOTICE PAL.

In addition to common definition plus the ability to handle sensors on the board.

• LED driver PCA9632

• Accelerometer MC3630

void setup() {
  auto&& brd = the_twelite.board.use<PAL_NOTICE>();
}

member object

sns_PCA9632

[PCA9632 device](... /... /sensor_object/pca9632-leddoraiba.md) object. The board definition performs Wire initialization and device initialization. In principle, it is controlled using the PCA9632 operation method described below.

When using coin cell batteries, periodic, momentary flashing can mitigate the effects of large currents.

For example, a setting that allows the LED to flash for 20 ms every second or so will not only maintain sufficient visual brightness to mitigate the above effects, but will also reduce battery drain. ) {endhint %}

sns_MC3630

MC3630 sensor object. The board definition includes SPI initialization, MC3630 device initialization, and MC3630 interrupt processing. Various processes are handled by sns_MC3630.

PCA9632-definition

static const uint8_t LED_OFF = SnsPCA9632::LED_OFF;
static const uint8_t LED_ON = SnsPCA9632::LED_PWM;
static const uint8_t LED_BLINK = SnsPCA9632::LED_BLINK;
static const uint8_t LED_NOP = SnsPCA9632::LED_NOP;

static const uint8_t LED_R = SnsPCA9632::LED1;
static const uint8_t LED_G = SnsPCA9632::LED2;
static const uint8_t LED_B = SnsPCA9632::LED3;
static const uint8_t LED_W = SnsPCA9632::LED4;

static const uint8_t LED_REG_MAX_PWM = 127;
static const uint8_t LED_REG_BOOST_PWM = 255;

Lighting Status

LED identification sub

Register Setting Definition

PCA9632-operating method

Master Switch

void set_led_master_sw_on() { digitalWrite(PIN_SNS_EN, LOW); }
void set_led_master_sw_off() { digitalWrite(PIN_SNS_EN, HIGH); }

NOTICE PAL has a FET switch at the rear of the PCA9632 output. The LED will not light unless this switch is turned ON.

Change of lighting status

void set_led_r_blink()
void set_led_r_on()
void set_led_r_off()
void set_led_g_on()
void set_led_g_blink()
void set_led_g_off()
void set_led_b_on()
void set_led_b_blink()
void set_led_b_off()
void set_led_w_on()
void set_led_w_blink()
void set_led_w_off()

Set individual LEDs to off, on, or blinking.

void set_leds(uint8_t r, uint8_t g, uint8_t b, uint8_t w)
void set_leds_off()

set_leds() changes the lighting status of all LEDs. Parameters are lighting statePAL_NOTICE::LED_OFF PAL_NOTICE::LED_ON PAL_NOTICE::LED_BLINK PAL_NOTICE::LED_NOP.

Light illumination control

void set_led_brightness_r_reg(uint8_t duty)
void set_led_brightness_g_reg(uint8_t duty)
void set_led_brightness_b_reg(uint8_t duty)
void set_led_brightness_w_reg(uint8_t duty)
void set_leds_brightness_reg(uint8_t r, uint8_t g, uint8_t b, uint8_t w)

void set_led_brightness_r1000(uint16_t duty, bool boost = false)
void set_led_brightness_g1000(uint16_t duty, bool boost = false)
void set_led_brightness_b1000(uint16_t duty, bool boost = false)
void set_led_brightness_w1000(uint16_t duty, bool boost = false)
void set_leds_brightness1000(
    uint16_t r, uint16_t g, uint16_t b, uint16_t w, bool boost = false)

Specifies the PWM duty ratio (LED lighting brightness).

set_led_brightness_? _reg() and set_leds_brightness_reg() specify the register value directly. 0...255 is specified and the lighting will be the ratio duty/256.

set_led_brightness_?1000() and set_leds_brightness1000() specify a duty ratio of 0..1000, where 0 corresponds to no light and the larger the value, the brighter (longer lighting interval). If boost is set to false, the register value is 127 when 1000 is specified. If boost is set to true, the register value will be 255.

Blinking Control

void set_blink_cycle_ms(uint16_t x)
void set_blink_duty1000(uint16_t x)

LEDs with PAL_NOTICE::LED_BLINK will blink with the specified period and lighting duration ratio.

• Blinking patterns cannot be specified individually.

• Brightness can also be controlled since the LEDs are turned on at the PWM duty ratio specified in the lighting illuminance setting above.

set_blink_cycle_ms() blinks for a period of time specified by x.

set_blink_duty1000()setsxto 0..1000 and blinks forcycle*x/1000` as the lighting period.

Test lighting

void test_led()

Turns on the 4 LEDs for a very short period of time. After lighting, the master switch is turned on (set_led_master_sw_on()).

TWELITE PAL's hardware has common parts, and board BEHAVIOR also defines common interfaces for common hardware.

constants

The following definitions are available

static const uint8_t PIN_BTN = 12; // button (as SET)
static const uint8_t PIN_LED = 5;  // LED
static const uint8_t PIN_WDT = 13; // WDT (shall tick every 60sec)

static const uint8_t PIN_D1 = 1; // DIP SW1
static const uint8_t PIN_D2 = 2; // DIP SW2
static const uint8_t PIN_D3 = 3; // DIP SW3
static const uint8_t PIN_D4 = 4; // DIP SW4

static const uint8_t PIN_SNS_EN = 16;
static const uint8_t PIN_SNS_INT = 17;

It can be accessed as PAL_AMB::PIN_BTN.

Hardware initialization

pinMode(PIN_BTN, INPUT_PULLUP);
pinMode(PIN_LED, OUTPUT_INIT_HIGH);
pinMode(PIN_WDT, OUTPUT_INIT_HIGH);

pinMode(PIN_D1, INPUT_PULLUP);
pinMode(PIN_D2, INPUT_PULLUP);
pinMode(PIN_D3, INPUT_PULLUP);
pinMode(PIN_D4, INPUT_PULLUP);

Each pin is initialized as shown in the code above.

Watchdog Timer

Resets the external watchdog timer at startup, sleep wakeup, and after a certain period of time after startup.

Methods

set_led()

void set_led(uint8_t mode, uint16_t tick)

LED (D1) control.

modeは以下のパラメータを取ります。tickは点灯時間[ms]を指定しますが、詳細はmodeの解説を参照してください。

led_one_shot()

void led_one_shot(uint16_t tick)

Turns on the LED for a specified period of time. Cannot be used at the same time as the set_led() function.

get_D1() .. D4(), get_DIPSW_BM()

inline uint8_t get_D1()
inline uint8_t get_D2()
inline uint8_t get_D3()
inline uint8_t get_D4()
inline uint8_t get_DIPSW_BM()

get_D1() ... get_D4() returns 0 when DIP SW is HIGH (switch is up) and 1 when it is LOW (switch is down).

get_DIPSW_BM() returns the DIP SW setting as 0..15. Returns the sum of SW1==LOW as 1, SW2 == LOW as 2, SW3 == LOW as 4 and SW4 == LOW as 8.