Merge pull request #378 from pimoroni/pcf85063a

Support for PCF85063A RTC
pull/389/head
Philip Howard 2022-06-13 18:41:49 +01:00 zatwierdzone przez GitHub
commit 8d329ccdd4
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
14 zmienionych plików z 990 dodań i 0 usunięć

Wyświetl plik

@ -33,3 +33,4 @@ add_subdirectory(servo)
add_subdirectory(encoder)
add_subdirectory(motor)
add_subdirectory(vl53l5cx)
add_subdirectory(pcf85063a)

Wyświetl plik

@ -0,0 +1 @@
include(pcf85063a.cmake)

Wyświetl plik

@ -0,0 +1,10 @@
set(DRIVER_NAME pcf85063a)
add_library(${DRIVER_NAME} INTERFACE)
target_sources(${DRIVER_NAME} INTERFACE
${CMAKE_CURRENT_LIST_DIR}/${DRIVER_NAME}.cpp)
target_include_directories(${DRIVER_NAME} INTERFACE ${CMAKE_CURRENT_LIST_DIR})
# Pull in pico libraries that we need
target_link_libraries(${DRIVER_NAME} INTERFACE pico_stdlib hardware_i2c hardware_rtc pimoroni_i2c)

Wyświetl plik

@ -0,0 +1,181 @@
#include "pcf85063a.hpp"
#include <chrono>
#include <cstdio>
// binary coded decimal conversion helper functions
uint8_t bcd_encode(uint v) {
uint v10 = v / 10, v1 = v - (v10 * 10); return v1 | (v10 << 4); }
int8_t bcd_decode(uint v) {
uint v10 = (v >> 4) & 0x0f, v1 = v & 0x0f; return v1 + (v10 * 10); }
namespace pimoroni {
void PCF85063A::init() {
if(interrupt != PIN_UNUSED) {
gpio_set_function(interrupt, GPIO_FUNC_SIO);
gpio_set_dir(interrupt, GPIO_IN);
gpio_set_pulls(interrupt, false, true);
}
reset();
}
void PCF85063A::reset() {
// magic soft reset command
i2c->reg_write_uint8(address, Registers::CONTROL_1, 0x58);
// read the oscillator status bit until it is cleared
uint8_t status = 0x80;
while(status & 0x80) {
// attempt to clear oscillator stop flag, then read it back
i2c->reg_write_uint8(address, Registers::OSCILLATOR_STATUS, 0x00);
status = i2c->reg_read_uint8(address, Registers::OSCILLATOR_STATUS);
}
}
// i2c helper methods
i2c_inst_t* PCF85063A::get_i2c() const {
return i2c->get_i2c();
}
int PCF85063A::get_address() const {
return address;
}
int PCF85063A::get_sda() const {
return i2c->get_sda();
}
int PCF85063A::get_scl() const {
return i2c->get_scl();
}
int PCF85063A::get_int() const {
return interrupt;
}
datetime_t PCF85063A::get_datetime() {
static uint8_t result[7] = {0};
i2c->read_bytes(address, Registers::SECONDS, result, 7);
datetime_t dt = {
.year = (int16_t)(bcd_decode(result[6]) + 2000), // offset year
.month = ( int8_t) bcd_decode(result[5]),
.day = ( int8_t) bcd_decode(result[3]),
.dotw = ( int8_t) bcd_decode(result[4]),
.hour = ( int8_t) bcd_decode(result[2]),
.min = ( int8_t) bcd_decode(result[1]),
.sec = ( int8_t) bcd_decode(result[0] & 0x7f) // mask out status bit
};
return dt;
}
void PCF85063A::set_datetime(datetime_t *t) {
static uint8_t data[7] = {
bcd_encode((uint)t->sec),
bcd_encode((uint)t->min),
bcd_encode((uint)t->hour),
bcd_encode((uint)t->day),
bcd_encode((uint)t->dotw),
bcd_encode((uint)t->month),
bcd_encode((uint)t->year - 2000) // offset year
};
i2c->write_bytes(address, Registers::SECONDS, data, 7);
}
void PCF85063A::set_alarm(int second, int minute, int hour, int day) {
uint8_t alarm[5] = {
uint8_t(second != PARAM_UNUSED ? bcd_encode(second) : 0x80),
uint8_t(minute != PARAM_UNUSED ? bcd_encode(minute) : 0x80),
uint8_t(hour != PARAM_UNUSED ? bcd_encode( hour) : 0x80),
uint8_t(day != PARAM_UNUSED ? bcd_encode( day) : 0x80),
uint8_t(0x80)
};
i2c->write_bytes(address, Registers::SECOND_ALARM, alarm, 5);
}
void PCF85063A::set_weekday_alarm(
int second, int minute, int hour, DayOfWeek dotw) {
uint8_t alarm[5] = {
uint8_t(second != PARAM_UNUSED ? bcd_encode(second) : 0x80),
uint8_t(minute != PARAM_UNUSED ? bcd_encode(minute) : 0x80),
uint8_t(hour != PARAM_UNUSED ? bcd_encode( hour) : 0x80),
uint8_t(0x80),
uint8_t(dotw != DayOfWeek::NONE ? bcd_encode( dotw) : 0x80)
};
i2c->write_bytes(address, Registers::SECOND_ALARM, alarm, 5);
}
void PCF85063A::enable_alarm_interrupt(bool enable) {
uint8_t bits = i2c->reg_read_uint8(address, Registers::CONTROL_2);
bits = enable ? (bits | 0x80) : (bits & ~0x80);
bits |= 0x40; // ensure alarm flag isn't reset
i2c->reg_write_uint8(address, Registers::CONTROL_2, bits);
}
bool PCF85063A::read_alarm_flag() {
uint8_t bits = i2c->reg_read_uint8(address, Registers::CONTROL_2);
return bits & 0x40;
}
void PCF85063A::clear_alarm_flag() {
uint8_t bits = i2c->reg_read_uint8(address, Registers::CONTROL_2);
bits &= ~0x40;
i2c->reg_write_uint8(address, Registers::CONTROL_2, bits);
}
void PCF85063A::unset_alarm() {
uint8_t dummy[5] = {0};
i2c->write_bytes(address, Registers::SECOND_ALARM, dummy, 5);
}
void PCF85063A::set_timer(uint8_t ticks, TimerTickPeriod ttp) {
uint8_t bits = i2c->reg_read_uint8(address, Registers::TIMER_MODE);
uint8_t timer[2] = {
ticks,
uint8_t((bits & ~0x18) | (ttp << 3) | 0x04) // mask out current ttp and set new + enable
};
i2c->write_bytes(address, Registers::TIMER_VALUE, timer, 2);
}
void PCF85063A::enable_timer_interrupt(bool enable, bool flag_only) {
uint8_t bits = i2c->reg_read_uint8(address, Registers::TIMER_MODE);
bits = (bits & ~0x03) | (enable ? 0x02 : 0x00) | (flag_only ? 0x01 : 0x00);
i2c->reg_write_uint8(address, Registers::TIMER_MODE, bits);
}
bool PCF85063A::read_timer_flag() {
uint8_t bits = i2c->reg_read_uint8(address, Registers::CONTROL_2);
return bits & 0x08;
}
void PCF85063A::clear_timer_flag() {
uint8_t bits = i2c->reg_read_uint8(address, Registers::CONTROL_2);
bits &= ~0x08;
i2c->reg_write_uint8(address, Registers::CONTROL_2, bits);
}
void PCF85063A::unset_timer() {
uint8_t bits = i2c->reg_read_uint8(address, Registers::TIMER_MODE);
bits &= ~0x04;
i2c->reg_write_uint8(address, Registers::TIMER_MODE, bits);
}
// set the speed of (or turn off) the clock output
void PCF85063A::set_clock_output(ClockOut co) {
uint8_t bits = i2c->reg_read_uint8(address, Registers::CONTROL_2);
bits = (bits & ~0x07) | uint8_t(co);
i2c->reg_write_uint8(
address, Registers::CONTROL_2, bits);
}
}

Wyświetl plik

@ -0,0 +1,138 @@
#pragma once
#include "hardware/i2c.h"
#include "hardware/rtc.h"
#include "common/pimoroni_common.hpp"
#include "common/pimoroni_i2c.hpp"
namespace pimoroni {
class PCF85063A {
//--------------------------------------------------
// Constants
//--------------------------------------------------
public:
static const uint DEFAULT_I2C_ADDRESS = 0x51;
static const int PARAM_UNUSED = -1;
//--------------------------------------------------
// Enums
//--------------------------------------------------
public:
enum ClockOut : uint8_t {
CLOCK_OUT_32768HZ = 0,
CLOCK_OUT_16384HZ = 1,
CLOCK_OUT_8192HZ = 2,
CLOCK_OUT_4096HZ = 3,
CLOCK_OUT_2048HZ = 4,
CLOCK_OUT_1024HZ = 5,
CLOCK_OUT_1HZ = 6,
CLOCK_OUT_OFF = 7
};
enum DayOfWeek : int8_t {
SUNDAY = 0,
MONDAY = 1,
TUESDAY = 2,
WEDNESDAY = 3,
THURSDAY = 4,
FRIDAY = 5,
SATURDAY = 6,
NONE = PARAM_UNUSED
};
enum TimerTickPeriod : int8_t {
TIMER_TICK_4096HZ = 0b00,
TIMER_TICK_64HZ = 0b01,
TIMER_TICK_1HZ = 0b10,
TIMER_TICK_1_OVER_60HZ = 0b11
};
private:
enum Registers : uint8_t {
CONTROL_1 = 0x00,
CONTROL_2 = 0x01,
OFFSET = 0x02,
RAM_BYTE = 0x03,
OSCILLATOR_STATUS = 0x04, // flag embedded in seconds register (see below)
SECONDS = 0x04, // contains oscillator status flag (see above)
MINUTES = 0x05,
HOURS = 0x06,
DAYS = 0x07,
WEEKDAYS = 0x08,
MONTHS = 0x09,
YEARS = 0x0A,
SECOND_ALARM = 0x0B,
MINUTE_ALARM = 0x0C,
HOUR_ALARM = 0x0D,
DAY_ALARM = 0x0E,
WEEKDAY_ALARM = 0x0F,
TIMER_VALUE = 0x10,
TIMER_MODE = 0x11
};
//--------------------------------------------------
// Variables
//--------------------------------------------------
private:
I2C *i2c;
// Interface pins with our standard defaults where appropriate
uint address = DEFAULT_I2C_ADDRESS;
uint interrupt = PIN_UNUSED;
//--------------------------------------------------
// Constructors/Destructor
//--------------------------------------------------
public:
PCF85063A() {}
PCF85063A(I2C *i2c, uint interrupt = PIN_UNUSED) :
i2c(i2c), interrupt(interrupt) {}
//--------------------------------------------------
// Methods
//--------------------------------------------------
public:
void init();
void reset();
// I2C instance details access methods
i2c_inst_t* get_i2c() const;
int get_address() const;
int get_sda() const;
int get_scl() const;
int get_int() const;
// Set and get the date and time
// Uses datetime_t from pico sdk (hardware/rtc) for compatibility
datetime_t get_datetime();
void set_datetime(datetime_t *t);
// Alarm manipulation methods
void set_alarm(int second = PARAM_UNUSED, int minute = PARAM_UNUSED,
int hour = PARAM_UNUSED, int day = PARAM_UNUSED);
void set_weekday_alarm(int second = PARAM_UNUSED, int minute = PARAM_UNUSED,
int hour = PARAM_UNUSED, DayOfWeek dotw = DayOfWeek::NONE);
void enable_alarm_interrupt(bool enable);
bool read_alarm_flag();
void clear_alarm_flag();
void unset_alarm();
// Timer manipulation methods
void set_timer(uint8_t ticks,
TimerTickPeriod ttp = TimerTickPeriod::TIMER_TICK_1HZ);
void enable_timer_interrupt(bool enable, bool flag_only = false);
bool read_timer_flag();
void clear_timer_flag();
void unset_timer();
// Clock output
void set_clock_output(ClockOut co);
};
}

Wyświetl plik

@ -35,6 +35,7 @@ add_subdirectory(pico_explorer_encoder)
add_subdirectory(pico_motor_shim)
add_subdirectory(pico_rgb_keypad)
add_subdirectory(pico_rtc_display)
add_subdirectory(pico_rtc)
add_subdirectory(pico_tof_display)
add_subdirectory(pico_trackball_display)
add_subdirectory(pico_audio)

Wyświetl plik

@ -0,0 +1,14 @@
set(OUTPUT_NAME rtc)
add_executable(
${OUTPUT_NAME}
demo.cpp
)
# Pull in pico libraries that we need
target_link_libraries(${OUTPUT_NAME} pico_stdlib pcf85063a)
pico_enable_stdio_usb(${OUTPUT_NAME} 1)
# create map/bin/hex file etc.
pico_add_extra_outputs(${OUTPUT_NAME})

Wyświetl plik

@ -0,0 +1,120 @@
#include <cstdio>
#include <stdio.h>
#include "pico/stdlib.h"
#include "pcf85063a.hpp"
using namespace pimoroni;
void led_on() {
}
void led_off() {
}
int main() {
// turn on led to show we're awake
gpio_set_function(6, GPIO_FUNC_SIO);
gpio_set_dir(6, GPIO_OUT);
gpio_put(6, true);
// keep the pico awake by holding vsys_en high
gpio_set_function(2, GPIO_FUNC_SIO);
gpio_set_dir(2, GPIO_OUT);
gpio_put(2, true);
// init usb serial for debugging and give our terminal monitor a bit of
// time to connect
stdio_init_all();
sleep_ms(500);
printf("\n\n\n");
printf("PCF85063A rtc demo!\n");
printf("===================\n");
sleep_ms(500);
printf("initialise rtc.. ");
I2C i2c(4, 5);
PCF85063A rtc(&i2c);
rtc.init();
printf("done!\n");
printf("\n");
printf("check clock function\n");
printf("\n");
printf("- setting date and time\n");
printf(" > 30/5/2022 08:07:12\n");
datetime_t now = {
.year = 2022, .month = 5, .day = 30, .hour = 8, .min = 7, .sec = 12
};
rtc.set_datetime(&now);
printf("\n");
printf("- sleeping for 3 seconds\n");
sleep_ms(3000);
printf("\n");
printf("- reading date and time\n");
now = rtc.get_datetime();
printf(" > %02d/%02d/%04d %02d:%02d:%02d\n",
now.day, now.month, now.year, now.hour, now.min, now.sec);
printf("\n");
printf("check alarm function\n");
printf("\n");
printf("- setting alarm for in 6 seconds\n");
printf(" > 08:07:21\n");
rtc.set_alarm(21, 7, 8);
printf("\n");
printf("- waiting for alarm flag\n");
while(!rtc.read_alarm_flag()) {
tight_loop_contents();
}
printf("\n");
printf("- alarm triggered at\n");
now = rtc.get_datetime();
printf(" > %02d/%02d/%04d %02d:%02d:%02d\n",
now.day, now.month, now.year, now.hour, now.min, now.sec);
printf("\n");
printf("- clear alarm flag\n");
rtc.clear_alarm_flag();
printf("check timer function\n");
printf("\n");
printf("- setting timer for in 5 seconds\n");
rtc.set_timer(5);
printf("\n");
printf("- waiting for timer flag\n");
while(!rtc.read_timer_flag()) {
tight_loop_contents();
}
printf("\n");
printf("- timer triggered at\n");
now = rtc.get_datetime();
printf(" > %02d/%02d/%04d %02d:%02d:%02d\n",
now.day, now.month, now.year, now.hour, now.min, now.sec);
printf("\n");
printf("- clear timer flag\n");
rtc.clear_alarm_flag();
printf("\n");
printf("tests complete\n");
return 0;
}

Wyświetl plik

@ -0,0 +1,91 @@
import machine
from pimoroni_i2c import PimoroniI2C
from pcf85063a import PCF85063A, MONDAY
import time
led = machine.Pin(6, machine.Pin.OUT)
led.high()
vsys_en = machine.Pin(2, machine.Pin.OUT)
vsys_en.high()
print("\n\n")
print("PCF85063A rtc demo!")
print("===================")
time.sleep(0.5)
print("initialise rtc.. ", end="")
PINS = {"sda": 4, "scl": 5} # i2c pins 4, 5
i2c = PimoroniI2C(**PINS)
rtc = PCF85063A(i2c)
print("done!")
print()
print("check clock function")
print()
print("- setting date and time")
print(" > 30/5/2022 08:07:12")
now = (2022, 5, 30, 8, 7, 12, MONDAY)
rtc.datetime(now)
print()
print("- sleeping for 3 seconds")
time.sleep(3)
print()
print("- reading date and time")
now = rtc.datetime()
print(" >", now)
print()
print("check alarm function")
print()
print("- setting alarm for in 6 seconds")
print(" > 08:07:21")
rtc.set_alarm(21, 7, 8)
print()
print("- waiting for alarm flag")
while not rtc.read_alarm_flag():
pass
print()
print("- alarm triggered at")
now = rtc.datetime()
print(" >", now)
print()
print("- clear alarm flag")
rtc.clear_alarm_flag()
print()
print("check timer function")
print()
print("- setting timer for in 5 seconds")
rtc.set_timer(5)
print()
print("- waiting for timer flag")
while not rtc.read_timer_flag():
pass
print()
print("- timer triggered at")
now = rtc.datetime()
print(" >", now)
print()
print("- clear timer flag")
rtc.clear_alarm_flag()
print()
print("tests complete")

Wyświetl plik

@ -41,6 +41,7 @@ include(qrcode/micropython/micropython)
include(adcfft/micropython)
include(st7789/micropython)
include(pcf85063a/micropython)
include(modules_py/modules_py)

Wyświetl plik

@ -0,0 +1,19 @@
set(MOD_NAME pcf85063a)
string(TOUPPER ${MOD_NAME} MOD_NAME_UPPER)
add_library(usermod_${MOD_NAME} INTERFACE)
target_sources(usermod_${MOD_NAME} INTERFACE
${CMAKE_CURRENT_LIST_DIR}/${MOD_NAME}.c
${CMAKE_CURRENT_LIST_DIR}/${MOD_NAME}.cpp
${CMAKE_CURRENT_LIST_DIR}/../../../drivers/pcf85063a/pcf85063a.cpp
)
target_include_directories(usermod_${MOD_NAME} INTERFACE
${CMAKE_CURRENT_LIST_DIR}
)
target_compile_definitions(usermod_${MOD_NAME} INTERFACE
-DMODULE_${MOD_NAME_UPPER}_ENABLED=1
)
target_link_libraries(usermod INTERFACE usermod_${MOD_NAME})

Wyświetl plik

@ -0,0 +1,98 @@
#include "pcf85063a.h"
////////////////////////////////////////////////////////////////////////////////////////////////////
// PCF85063A Class
////////////////////////////////////////////////////////////////////////////////////////////////////
/***** Methods *****/
MP_DEFINE_CONST_FUN_OBJ_1(PCF85063A_reset_obj, PCF85063A_reset);
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(PCF85063A_datetime_obj, 1, 2, PCF85063A_datetime);
MP_DEFINE_CONST_FUN_OBJ_KW(PCF85063A_set_alarm_obj, 1, PCF85063A_set_alarm);
MP_DEFINE_CONST_FUN_OBJ_KW(PCF85063A_set_weekday_alarm_obj, 1, PCF85063A_set_weekday_alarm);
MP_DEFINE_CONST_FUN_OBJ_2(PCF85063A_enable_alarm_interrupt_obj, PCF85063A_enable_alarm_interrupt);
MP_DEFINE_CONST_FUN_OBJ_1(PCF85063A_read_alarm_flag_obj, PCF85063A_read_alarm_flag);
MP_DEFINE_CONST_FUN_OBJ_1(PCF85063A_clear_alarm_flag_obj, PCF85063A_clear_alarm_flag);
MP_DEFINE_CONST_FUN_OBJ_1(PCF85063A_unset_alarm_obj, PCF85063A_unset_alarm);
MP_DEFINE_CONST_FUN_OBJ_KW(PCF85063A_set_timer_obj, 2, PCF85063A_set_timer);
MP_DEFINE_CONST_FUN_OBJ_KW(PCF85063A_enable_timer_interrupt_obj, 2, PCF85063A_enable_timer_interrupt);
MP_DEFINE_CONST_FUN_OBJ_1(PCF85063A_read_timer_flag_obj, PCF85063A_read_timer_flag);
MP_DEFINE_CONST_FUN_OBJ_1(PCF85063A_clear_timer_flag_obj, PCF85063A_clear_timer_flag);
MP_DEFINE_CONST_FUN_OBJ_1(PCF85063A_unset_timer_obj, PCF85063A_unset_timer);
MP_DEFINE_CONST_FUN_OBJ_2(PCF85063A_set_clock_output_obj, PCF85063A_set_clock_output);
/***** Binding of Methods *****/
STATIC const mp_rom_map_elem_t PCF85063A_locals_dict_table[] = {
{ MP_ROM_QSTR(MP_QSTR_reset), MP_ROM_PTR(&PCF85063A_reset_obj) },
{ MP_ROM_QSTR(MP_QSTR_datetime), MP_ROM_PTR(&PCF85063A_datetime_obj) },
{ MP_ROM_QSTR(MP_QSTR_set_alarm), MP_ROM_PTR(&PCF85063A_set_alarm_obj) },
{ MP_ROM_QSTR(MP_QSTR_set_weekday_alarm), MP_ROM_PTR(&PCF85063A_set_weekday_alarm_obj) },
{ MP_ROM_QSTR(MP_QSTR_enable_alarm_interrupt), MP_ROM_PTR(&PCF85063A_enable_alarm_interrupt_obj) },
{ MP_ROM_QSTR(MP_QSTR_read_alarm_flag), MP_ROM_PTR(&PCF85063A_read_alarm_flag_obj) },
{ MP_ROM_QSTR(MP_QSTR_clear_alarm_flag), MP_ROM_PTR(&PCF85063A_clear_alarm_flag_obj) },
{ MP_ROM_QSTR(MP_QSTR_unset_alarm), MP_ROM_PTR(&PCF85063A_unset_alarm_obj) },
{ MP_ROM_QSTR(MP_QSTR_set_timer), MP_ROM_PTR(&PCF85063A_set_timer_obj) },
{ MP_ROM_QSTR(MP_QSTR_enable_timer_interrupt), MP_ROM_PTR(&PCF85063A_enable_timer_interrupt_obj) },
{ MP_ROM_QSTR(MP_QSTR_read_timer_flag), MP_ROM_PTR(&PCF85063A_read_timer_flag_obj) },
{ MP_ROM_QSTR(MP_QSTR_clear_timer_flag), MP_ROM_PTR(&PCF85063A_clear_timer_flag_obj) },
{ MP_ROM_QSTR(MP_QSTR_unset_timer), MP_ROM_PTR(&PCF85063A_unset_timer_obj) },
{ MP_ROM_QSTR(MP_QSTR_set_clock_output), MP_ROM_PTR(&PCF85063A_set_clock_output_obj) },
};
STATIC MP_DEFINE_CONST_DICT(PCF85063A_locals_dict, PCF85063A_locals_dict_table);
/***** Class Definition *****/
const mp_obj_type_t pcf85063a_PCF85063A_type = {
{ &mp_type_type },
.name = MP_QSTR_pcf85063a,
.make_new = PCF85063A_make_new,
.locals_dict = (mp_obj_dict_t*)&PCF85063A_locals_dict,
};
////////////////////////////////////////////////////////////////////////////////////////////////////
// pcf85063a Module
////////////////////////////////////////////////////////////////////////////////////////////////////
/***** Globals Table *****/
STATIC const mp_map_elem_t pcf85063a_globals_table[] = {
{ MP_OBJ_NEW_QSTR(MP_QSTR___name__), MP_OBJ_NEW_QSTR(MP_QSTR_pcf85063a) },
{ MP_OBJ_NEW_QSTR(MP_QSTR_PCF85063A), (mp_obj_t)&pcf85063a_PCF85063A_type },
{ MP_ROM_QSTR(MP_QSTR_CLOCK_OUT_32768HZ), MP_ROM_INT(0) },
{ MP_ROM_QSTR(MP_QSTR_CLOCK_OUT_16384HZ), MP_ROM_INT(1) },
{ MP_ROM_QSTR(MP_QSTR_CLOCK_OUT_8192HZ), MP_ROM_INT(2) },
{ MP_ROM_QSTR(MP_QSTR_CLOCK_OUT_4096HZ), MP_ROM_INT(3) },
{ MP_ROM_QSTR(MP_QSTR_CLOCK_OUT_2048HZ), MP_ROM_INT(4) },
{ MP_ROM_QSTR(MP_QSTR_CLOCK_OUT_1024HZ), MP_ROM_INT(5) },
{ MP_ROM_QSTR(MP_QSTR_CLOCK_OUT_1HZ), MP_ROM_INT(6) },
{ MP_ROM_QSTR(MP_QSTR_CLOCK_OUT_OFF), MP_ROM_INT(7) },
{ MP_ROM_QSTR(MP_QSTR_TIMER_TICK_4096HZ), MP_ROM_INT(0b00) },
{ MP_ROM_QSTR(MP_QSTR_TIMER_TICK_64HZ), MP_ROM_INT(0b01) },
{ MP_ROM_QSTR(MP_QSTR_TIMER_TICK_1HZ), MP_ROM_INT(0b10) },
{ MP_ROM_QSTR(MP_QSTR_TIMER_TICK_1_OVER_60HZ), MP_ROM_INT(0b11) },
{ MP_ROM_QSTR(MP_QSTR_MONDAY), MP_ROM_INT(0) },
{ MP_ROM_QSTR(MP_QSTR_TUESDAY), MP_ROM_INT(1) },
{ MP_ROM_QSTR(MP_QSTR_WEDNESDAY), MP_ROM_INT(2) },
{ MP_ROM_QSTR(MP_QSTR_THURSDAY), MP_ROM_INT(3) },
{ MP_ROM_QSTR(MP_QSTR_FRIDAY), MP_ROM_INT(4) },
{ MP_ROM_QSTR(MP_QSTR_SATURDAY), MP_ROM_INT(5) },
{ MP_ROM_QSTR(MP_QSTR_SUNDAY), MP_ROM_INT(6) },
};
STATIC MP_DEFINE_CONST_DICT(mp_module_pcf85063a_globals, pcf85063a_globals_table);
/***** Module Definition *****/
const mp_obj_module_t pcf85063a_user_cmodule = {
.base = { &mp_type_module },
.globals = (mp_obj_dict_t*)&mp_module_pcf85063a_globals,
};
////////////////////////////////////////////////////////////////////////////////////////////////////
MP_REGISTER_MODULE(MP_QSTR_pcf85063a, pcf85063a_user_cmodule, MODULE_BREAKOUT_RTC_ENABLED);
////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////

Wyświetl plik

@ -0,0 +1,289 @@
#include "drivers/pcf85063a/pcf85063a.hpp"
#include "micropython/modules/util.hpp"
#include <string>
#include <cstring>
using namespace pimoroni;
extern "C" {
#include "pcf85063a.h"
#include "pimoroni_i2c.h"
/***** Variables Struct *****/
typedef struct _pcf85063a_PCF85063A_obj_t {
mp_obj_base_t base;
PCF85063A *breakout;
_PimoroniI2C_obj_t *i2c;
} pcf85063a_PCF85063A_obj_t;
/***** Constructor *****/
mp_obj_t PCF85063A_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
pcf85063a_PCF85063A_obj_t *self = nullptr;
enum { ARG_i2c, ARG_interrupt };
static const mp_arg_t allowed_args[] = {
{ MP_QSTR_i2c, MP_ARG_OBJ, {.u_obj = nullptr} },
{ MP_QSTR_interrupt, MP_ARG_INT, {.u_int = PIN_UNUSED} },
};
// Parse args.
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
mp_arg_parse_all_kw_array(n_args, n_kw, all_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
self = m_new_obj(pcf85063a_PCF85063A_obj_t);
self->base.type = &pcf85063a_PCF85063A_type;
self->i2c = PimoroniI2C_from_machine_i2c_or_native(args[ARG_i2c].u_obj);
self->breakout = m_new_class(PCF85063A, (pimoroni::I2C *)(self->i2c->i2c), args[ARG_interrupt].u_int);
self->breakout->init();
return MP_OBJ_FROM_PTR(self);
}
mp_obj_t PCF85063A_reset(mp_obj_t self_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
self->breakout->reset();
return mp_const_none;
}
mp_obj_t PCF85063A_datetime(size_t n_args, const mp_obj_t *args) {
enum { ARG_self, ARG_time };
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(args[ARG_self], pcf85063a_PCF85063A_obj_t);
if(n_args == 1) {
datetime_t t = self->breakout->get_datetime();
// Return the date
mp_obj_t tuple[7];
tuple[0] = mp_obj_new_int(t.year);
tuple[1] = mp_obj_new_int(t.month);
tuple[2] = mp_obj_new_int(t.day);
tuple[3] = mp_obj_new_int(t.hour);
tuple[4] = mp_obj_new_int(t.min);
tuple[5] = mp_obj_new_int(t.sec);
tuple[6] = mp_obj_new_int((t.dotw + 6) % 7);
return mp_obj_new_tuple(7, tuple);
}
else {
// Provide a new date
const mp_obj_t object = args[ARG_time];
size_t length = 0;
mp_obj_t *items = nullptr;
if(mp_obj_is_type(object, &mp_type_list)) {
mp_obj_list_t *list = MP_OBJ_TO_PTR2(object, mp_obj_list_t);
length = list->len;
items = list->items;
}
else if(mp_obj_is_type(object, &mp_type_tuple)) {
mp_obj_tuple_t *tuple = MP_OBJ_TO_PTR2(object, mp_obj_tuple_t);
length = tuple->len;
items = tuple->items;
}
if(items == nullptr) mp_raise_TypeError("cannot convert object to a list or tuple of integers");
if(length < 7 || length > 8) mp_raise_TypeError("list or tuple must contain integers in the form (year, month, mday, hour, minute, second, weekday)");
int year = mp_obj_get_int(items[0]);
int month = mp_obj_get_int(items[1]);
int day = mp_obj_get_int(items[2]);
int hour = mp_obj_get_int(items[3]);
int minute = mp_obj_get_int(items[4]);
int second = mp_obj_get_int(items[5]);
int dotw = mp_obj_get_int(items[6]);
if(year < 2000 || year > 2099) mp_raise_ValueError("year out of range. Expected 2000 to 2099");
if(month < 1 || month > 12) mp_raise_ValueError("month out of range. Expected 1 to 12");
if(day < 1 || day > 31) mp_raise_ValueError("day out of range. Expected 1 to 31");
if(hour < 0 || hour > 23) mp_raise_ValueError("hour out of range. Expected 0 to 23");
if(minute < 0 || minute > 59) mp_raise_ValueError("minute out of range. Expected 0 to 59");
if(second < 0 || second > 59) mp_raise_ValueError("second out of range. Expected 0 to 59");
if(dotw < 0 || dotw > 6) mp_raise_ValueError("dotw out of range. Expected 0 to 6");
datetime_t t;
t.year = year;
t.month = month;
t.day = day;
t.hour = hour;
t.min = minute;
t.sec = second;
t.dotw = (dotw + 1) % 7;
self->breakout->set_datetime(&t);
}
return mp_const_none;
}
mp_obj_t PCF85063A_set_alarm(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_self, ARG_second, ARG_minute, ARG_hour, ARG_day};
static const mp_arg_t allowed_args[] = {
{ MP_QSTR_, MP_ARG_REQUIRED | MP_ARG_OBJ },
{ MP_QSTR_second, MP_ARG_INT, { .u_int = PCF85063A::PARAM_UNUSED }},
{ MP_QSTR_minute, MP_ARG_INT, { .u_int = PCF85063A::PARAM_UNUSED }},
{ MP_QSTR_hour, MP_ARG_INT, { .u_int = PCF85063A::PARAM_UNUSED }},
{ MP_QSTR_day, MP_ARG_INT, { .u_int = PCF85063A::PARAM_UNUSED }},
};
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(args[ARG_self].u_obj, pcf85063a_PCF85063A_obj_t);
int second = args[ARG_second].u_int;
int minute = args[ARG_minute].u_int;
int hour = args[ARG_hour].u_int;
int day = args[ARG_day].u_int;
if(second != PCF85063A::PARAM_UNUSED && (second < 0 || second > 59))
mp_raise_ValueError("second out of range. Expected 0 to 59");
if(minute != PCF85063A::PARAM_UNUSED && (minute < 0 || minute > 59))
mp_raise_ValueError("minute out of range. Expected 0 to 59");
if(hour != PCF85063A::PARAM_UNUSED && (hour < 0 || hour > 23))
mp_raise_ValueError("hour out of range. Expected 0 to 23");
if(day != PCF85063A::PARAM_UNUSED && (day < 1 || day > 31))
mp_raise_ValueError("date out of range. Expected 1 to 31");
self->breakout->set_alarm(second, minute, hour, day);
return mp_const_none;
}
mp_obj_t PCF85063A_set_weekday_alarm(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_self, ARG_second, ARG_minute, ARG_hour, ARG_dotw};
static const mp_arg_t allowed_args[] = {
{ MP_QSTR_, MP_ARG_REQUIRED | MP_ARG_OBJ },
{ MP_QSTR_second, MP_ARG_INT, { .u_int = PCF85063A::PARAM_UNUSED }},
{ MP_QSTR_minute, MP_ARG_INT, { .u_int = PCF85063A::PARAM_UNUSED }},
{ MP_QSTR_hour, MP_ARG_INT, { .u_int = PCF85063A::PARAM_UNUSED }},
{ MP_QSTR_dotw, MP_ARG_INT, { .u_int = PCF85063A::PARAM_UNUSED }},
};
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(args[ARG_self].u_obj, pcf85063a_PCF85063A_obj_t);
int second = args[ARG_second].u_int;
int minute = args[ARG_minute].u_int;
int hour = args[ARG_hour].u_int;
int dotw = args[ARG_dotw].u_int;
if(second != PCF85063A::PARAM_UNUSED && (second < 0 || second > 59))
mp_raise_ValueError("second out of range. Expected 0 to 59");
if(minute != PCF85063A::PARAM_UNUSED && (minute < 0 || minute > 59))
mp_raise_ValueError("minute out of range. Expected 0 to 59");
if(hour != PCF85063A::PARAM_UNUSED && (hour < 0 || hour > 23))
mp_raise_ValueError("hour out of range. Expected 0 to 23");
if(dotw != PCF85063A::PARAM_UNUSED && (dotw < 0 || dotw > 6))
mp_raise_ValueError("dotw out of range. Expected 0 to 6");
self->breakout->set_weekday_alarm(second, minute, hour, (PCF85063A::DayOfWeek)dotw);
return mp_const_none;
}
mp_obj_t PCF85063A_enable_alarm_interrupt(mp_obj_t self_in, mp_obj_t enable_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
self->breakout->enable_alarm_interrupt(enable_in == mp_const_true);
return mp_const_none;
}
mp_obj_t PCF85063A_read_alarm_flag(mp_obj_t self_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
return mp_obj_new_bool(self->breakout->read_alarm_flag());
}
mp_obj_t PCF85063A_clear_alarm_flag(mp_obj_t self_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
self->breakout->clear_alarm_flag();
return mp_const_none;
}
mp_obj_t PCF85063A_unset_alarm(mp_obj_t self_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
self->breakout->unset_alarm();
return mp_const_none;
}
mp_obj_t PCF85063A_set_timer(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_self, ARG_ticks, ARG_ttp};
static const mp_arg_t allowed_args[] = {
{ MP_QSTR_, MP_ARG_REQUIRED | MP_ARG_OBJ },
{ MP_QSTR_ticks, MP_ARG_REQUIRED | MP_ARG_INT},
{ MP_QSTR_ttp, MP_ARG_INT, { .u_int = PCF85063A::TIMER_TICK_1HZ}},
};
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(args[ARG_self].u_obj, pcf85063a_PCF85063A_obj_t);
int ticks = args[ARG_ticks].u_int;
int ttp = args[ARG_ttp].u_int;
if(ticks < 0 || ticks > 255) mp_raise_ValueError("ticks out of range. Expected 0 to 255");
if(ttp < 0 || ttp > 3) mp_raise_ValueError("ttp out of range. Expected 0 to 3");
self->breakout->set_timer(ticks, (PCF85063A::TimerTickPeriod)ttp);
return mp_const_none;
}
mp_obj_t PCF85063A_enable_timer_interrupt(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
enum { ARG_self, ARG_enable, ARG_flag_only};
static const mp_arg_t allowed_args[] = {
{ MP_QSTR_, MP_ARG_REQUIRED | MP_ARG_OBJ },
{ MP_QSTR_enable, MP_ARG_REQUIRED | MP_ARG_BOOL},
{ MP_QSTR_flag_only, MP_ARG_BOOL, { .u_bool = false}},
};
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(args[ARG_self].u_obj, pcf85063a_PCF85063A_obj_t);
bool enable = args[ARG_enable].u_bool;
bool flag_only = args[ARG_flag_only].u_bool;
self->breakout->enable_timer_interrupt(enable, flag_only);
return mp_const_none;
}
mp_obj_t PCF85063A_read_timer_flag(mp_obj_t self_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
return mp_obj_new_bool(self->breakout->read_timer_flag());
}
mp_obj_t PCF85063A_clear_timer_flag(mp_obj_t self_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
self->breakout->clear_timer_flag();
return mp_const_none;
}
mp_obj_t PCF85063A_unset_timer(mp_obj_t self_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
self->breakout->unset_timer();
return mp_const_none;
}
mp_obj_t PCF85063A_set_clock_output(mp_obj_t self_in, mp_obj_t co_in) {
pcf85063a_PCF85063A_obj_t *self = MP_OBJ_TO_PTR2(self_in, pcf85063a_PCF85063A_obj_t);
int co = mp_obj_get_int(co_in) & 7; // Clamp to 0-7
self->breakout->set_clock_output((PCF85063A::ClockOut)co);
return mp_const_none;
}
}

Wyświetl plik

@ -0,0 +1,26 @@
// Include MicroPython API.
#include "py/runtime.h"
/***** Extern of Class Definition *****/
extern const mp_obj_type_t pcf85063a_PCF85063A_type;
/***** Extern of Class Methods *****/
extern mp_obj_t PCF85063A_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args);
extern mp_obj_t PCF85063A_reset(mp_obj_t self_in);
extern mp_obj_t PCF85063A_datetime(size_t n_args, const mp_obj_t *args);
extern mp_obj_t PCF85063A_set_alarm(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args);
extern mp_obj_t PCF85063A_set_weekday_alarm(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args);
extern mp_obj_t PCF85063A_enable_alarm_interrupt(mp_obj_t self_in, mp_obj_t enable_in);
extern mp_obj_t PCF85063A_clear_alarm_flag(mp_obj_t self_in);
extern mp_obj_t PCF85063A_read_alarm_flag(mp_obj_t self_in);
extern mp_obj_t PCF85063A_unset_alarm(mp_obj_t self_in);
extern mp_obj_t PCF85063A_set_timer(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args);
extern mp_obj_t PCF85063A_enable_timer_interrupt(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args);
extern mp_obj_t PCF85063A_clear_timer_flag(mp_obj_t self_in);
extern mp_obj_t PCF85063A_read_timer_flag(mp_obj_t self_in);
extern mp_obj_t PCF85063A_unset_timer(mp_obj_t self_in);
extern mp_obj_t PCF85063A_set_clock_output(mp_obj_t self_in, mp_obj_t co_in);