rtc.ts

// Add your code here

enum TimeItem {
    //% block="second"
    SECOND = 1,
    //% block="minute"
    MINUTE = 2,
    //% block="hour"
    HOUR = 3,
    //% block="weekday"
    WEEKDAY = 4,
    //% block="day"
    DAY = 5,
    //% block="month"
    MONTH = 6,
    //% block="year"
    YEAR = 7
}

enum AlarmItem {
    //% block="second"
    SECOND = 1,
    //% block="minute"
    MINUTE = 2,
    //% block="hour"
    HOUR = 3,
    //% block="weekday"
    WEEKDAY = 4,
    //% block="day"
    DAY = 5
}

enum WeekItem {
    //% block="monday"
    MONDAY = 1,
    //% block="tuesday"
    TUESDAY = 2,
    //% block="wednesday"
    WEDNESDAY = 3,
    //% block="thursday"
    THURSDAY = 4,
    //% block="friday"
    FRIDAY = 5,
    //% block="saturday"
    SATURDAY = 6,
    //% block="sunday"
    SUNDAY = 7
}

enum RepeatMode {
    //% block="everyday"
    EVERYDAY = 1,
    //% block="everymonth"
    EVERYMONTH = 2,
    //% block="everyweek"
    EVERYWEEK = 3,
    //% block="everyhour"
    EVERYHOUR = 4,
    //% block="everyminute"
    EVERYMINUTE = 5,
    //% block="everysecond"
    EVERYSECOND = 6
}

declare namespace pins {
    /**
     * Pin Alarm Interupt
     */
    //% fixedInstance shim=pxt::lookupPinCfg(CFG_PIN_D0)
    const AlarmIntPin: DigitalInOutPin;
}

//% color="#7a5327" weight=75 icon="\uf133" block="RTC"
//% groups='["Time","Alarm"]'
namespace rtc {

    const DS1339_I2C_ADDRESS = 0x68  //I2C address of the DS1339

    const REG_DS1339_SECONDS = 0x00
    const REG_DS1339_MINUTES = 0x01
    const REG_DS1339_HOURS = 0x02
    const REG_DS1339_DAY = 0x03
    const REG_DS1339_DATE = 0x04
    const REG_DS1339_MONTH = 0x05
    const REG_DS1339_YEAR = 0x06
    const REG_DS1339_ALARM1_SECONDS = 0x07
    const REG_DS1339_ALARM1_MINUTES = 0x08
    const REG_DS1339_ALARM1_HOURS = 0x09
    const REG_DS1339_ALARM1_DAYDATE = 0x0A
    const REG_DS1339_ALARM2_MINUTES = 0x0B
    const REG_DS1339_ALARM2_HOURS = 0x0C
    const REG_DS1339_ALARM2_DAYDATE = 0x0D
    const REG_DS1339_CONTROL = 0x0E
    const REG_DS1339_STATUS = 0x0F
    const REG_DS1339_TRICKLE_CHARGER = 0x10

    const DS1339_ALARM1_ADDR = 0x07
    const DS1339_ALARM2_ADDR = 0x0B

    //% fixedInstances
    export class DS1339 {
        isConnected: boolean;

        constructor() {
            this.isConnected = false;
            this.start();

            if (this.isConnected) {
                this.clearAlarmIntStatus();
            }
        }

        private connect() {
            let retry = 0;
            while (!this.isConnected && retry < 5) {

                //REGISTER FORMAT:   CMD | TRANSACTION | ADDRESS
                //REGISTER READ:     TCS34725_REGISTER_COMMAND (0x80) | TCS34725_REGISTER_ID (0x12)
                const sec = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_SECONDS)

                //Check that device Identification has one of 2 i2c addresses         
                if (sec != undefined)
                    this.isConnected = true;

                retry++;
            }
        }

        private start() {
            this.connect();
        }

        get second() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_SECONDS);

            return (reg >> 4 & 0x07) * 10 + (reg & 0x0F)
        }

        get minute() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_MINUTES);

            return (reg >> 4 & 0x07) * 10 + (reg & 0x0F)
        }

        get hour() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_HOURS);

            return (reg >> 5 & 0x01) * 20 + (reg >> 4 & 0x01) * 10 + (reg & 0x0F);
        }

        get weekday() {
            this.connect();

            if (!this.isConnected)
                return 1;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_DAY);

            if (!reg)
                return 1;

            return reg & 0x07;
        }

        get day() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_DATE);

            return (reg >> 4 & 0x03) * 10 + (reg & 0x0F)
        }

        get month() {
            this.connect();

            if (!this.isConnected)
                return 1;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_MONTH);

            if (!reg)
                return 1;

            return (reg >> 4 & 0x01) * 10 + (reg & 0x0F)
        }

        get year() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_YEAR);

            return (reg >> 4 & 0x0F) * 10 + (reg & 0x0F)
        }

        set alarmSecond(sec: number) {
            this.connect();

            if (!this.isConnected)
                return;

            const reg = ((sec / 10 & 0x07) << 4) + (sec % 10 & 0x0F);
            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_SECONDS, reg);
        }

        get alarmSecond() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_SECONDS);

            return (reg >> 4 & 0x07) * 10 + (reg & 0x0F)
        }

        set alarmMinute(minu: number) {
            this.connect();

            if (!this.isConnected)
                return;

            const reg = ((minu / 10 & 0x07) << 4) + (minu % 10 & 0x0F);
            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_MINUTES, reg);
        }

        get alarmMinute() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_MINUTES);

            return (reg >> 4 & 0x07) * 10 + (reg & 0x0F)
        }

        set alarmHour(hour: number) {
            this.connect();

            if (!this.isConnected)
                return;

            const reg = ((hour / 10 & 0x03) << 4) + (hour % 10 & 0x0F);

            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_HOURS, reg);
        }

        get alarmHour() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_HOURS);

            return (reg >> 5 & 0x01) * 20 + (reg >> 4 & 0x01) * 10 + (reg & 0x0F);
        }

        set alarmWeekday(val: number) {
            this.connect();

            if (!this.isConnected)
                return;

            // const mask = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE);
            const reg = /* (mask & 0x80) + */ 0x40 + (val & 0x0F);

            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE, reg);
        }

        get alarmWeekday() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE);
            const isWeekday = reg >> 6 & 0x01;

            if (isWeekday) {
                return reg & 0x0F;
            } else {
                return undefined;
            }
        }

        set alarmDay(val: number) {
            this.connect();

            if (!this.isConnected)
                return;

            // const mask = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE);
            const reg = /* (mask & 0x80) + */ ((val / 10 & 0x03) << 4) + (val & 0x0F);

            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE, reg);
        }

        get alarmDay() {
            this.connect();

            if (!this.isConnected)
                return 0;

            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE);
            const isDay = reg >> 6 & 0x01;

            if (isDay) {
                return undefined;
            } else {
                return (reg >> 4 & 0x03) * 10 + (reg & 0x0F);
            }
        }

        set alarmRepeatMode(mode: RepeatMode) {
            this.connect();

            if (!this.isConnected)
                return;

            let day = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE);
            let hour = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_HOURS);
            let minute = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_MINUTES);
            let second = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_SECONDS);

            if (mode == RepeatMode.EVERYMONTH) {
                day = day & 0x3F;
                hour = hour & 0x7F;
                minute = minute & 0x7F;
                second = second & 0x7F;
            } else if (mode == RepeatMode.EVERYWEEK) {
                day = (day & 0x3F) | 0x40;
                hour = hour & 0x7F;
                minute = minute & 0x7F;
                second = second & 0x7F;
            } else if (mode == RepeatMode.EVERYDAY) {
                day = day | 0x80;
                hour = hour & 0x7F;
                minute = minute & 0x7F;
                second = second & 0x7F;
            } else if (mode == RepeatMode.EVERYHOUR) {
                day = day | 0x80;
                hour = hour | 0x80;
                minute = minute & 0x7F;
                second = second & 0x7F;
            } else if (mode == RepeatMode.EVERYMINUTE) {
                day = day | 0x80;
                hour = hour | 0x80;
                minute = minute | 0x80;
                second = second & 0x7F;
            } else if (mode == RepeatMode.EVERYSECOND) {
                day = day | 0x80;
                hour = hour | 0x80;
                minute = minute | 0x80;
                second = second | 0x80;
            }

            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE, day);
            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_HOURS, hour);
            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_MINUTES, minute);
            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_SECONDS, second);
        }

        get alarmRepeatMode() {
            this.connect();

            if (!this.isConnected)
                return 0;

            let day = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE);
            let hour = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_HOURS);
            let minute = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_MINUTES);
            let second = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_SECONDS);

            if (second & 0x80) {
                return RepeatMode.EVERYSECOND;
            } else if (minute & 0x80) {
                return RepeatMode.EVERYMINUTE;
            } else if (hour & 0x80) {
                return RepeatMode.EVERYHOUR;
            } else if (day & 0x80) {
                return RepeatMode.EVERYDAY;
            } else if (day & 0x40) {
                return RepeatMode.EVERYWEEK;
            } else {
                return RepeatMode.EVERYMONTH;
            }
        }

        set alarmInt(int: boolean) {
            let reg;

            if (int) {
                reg = 0x1D;
            } else {
                reg = 0x1C;
            }

            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_CONTROL, reg);
        }

        get alarmInt() {
            const reg = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_CONTROL);

            if (reg & 0x01) {
                return true;
            } else {
                return false;
            }
        }

        clearAlarmIntStatus() {
            pins.i2cWriteRegister(DS1339_I2C_ADDRESS, REG_DS1339_STATUS, 0);
        }
    }

    export const ds1339 = new DS1339();

    /**
     * Read string format time.
     */
    //% group="Time"
    //% weight=99
    //% blockId=rtc_read_format_time block="string format time %format "
    //% format.defl="hh:mm"
    //% help=rtc/read-format-time
    export function stringFormatTime(format: string): string {
        const weekList = [
            'Monday', 
            'Tuesday', 
            'Wednesday', 
            'Thursday', 
            'Friday', 
            'Saturday', 
            'Sunday'
        ];
        const weekListAbbr = [
            'Mon.',
            'Tue.',
            'Wed.',
            'Thu.',
            'Fri.',
            'Sat.',
            'Sun.'
        ];
        const monthList = [
            'January',
            'February',
            'March',
            'April',
            'May',
            'June',
            'July',
            'August',
            'September',
            'October',
            'November',
            'December'
        ];
        const monthListAbbr = [
            'Jan.',
            'Feb.',
            'Mar.',
            'Apr.',
            'May',
            'Jun.',
            'Jul.',
            'Aug.',
            'Sep.',
            'Oct.',
            'Nov.',
            'Dec.'
        ];

        let year = ds1339.year;
        let month = ds1339.month;
        let date = ds1339.day;
        let hours = ds1339.hour;
        let minutes = ds1339.minute;
        let seconds = ds1339.second;
        let week = ds1339.weekday;

        let yearStr = year >= 10 ? year.toString() : ('0' + year);
        let monthStr = month >= 10 ? month.toString() : ('0' + month);
        let dateStr = date >= 10 ? date.toString() : ('0' + date);
        let hoursStr = hours >= 10 ? hours.toString() : ('0' + hours);
        let minutesStr = minutes >= 10 ? minutes.toString() : ('0' + minutes);
        let secondsStr = seconds >= 10 ? seconds.toString() : ('0' + seconds);

        if (format.indexOf('YYYY') !== -1) {
            format = format.replace('YYYY', '20' + yearStr);
        } else {
            format = format.replace('YY', yearStr);
        }

        if (format.indexOf('MMMM') !== -1) {
            format = format.replace('MMMM', monthList[month - 1]);
        } else if (format.indexOf('MMM') !== -1) {
            format = format.replace('MMM', monthListAbbr[month - 1]);
        }else {
            format = format.replace('MM', monthStr);
        }
        
        format = format.replace('DD', dateStr);
        format = format.replace('hh', hoursStr);
        format = format.replace('mm', minutesStr);
        format = format.replace('ss', secondsStr);

        if (format.indexOf('WWW') !== -1) {
            format = format.replace('WWW', weekList[week - 1]);
        } else {
            format = format.replace('WW', weekListAbbr[week - 1]);
        }

        return format;
    }

    /**
     * Read rtc time item.
     */
    //% group="Time" 
    //% weight=100
    //% blockId=rtc_read block="%item"
    //% help=rtc/read-time
    export function time(item: TimeItem = TimeItem.SECOND): number {
        switch (item) {
            case TimeItem.SECOND:
                return ds1339.second;
            case TimeItem.MINUTE:
                return ds1339.minute;
            case TimeItem.HOUR:
                return ds1339.hour;
            case TimeItem.WEEKDAY:
                return ds1339.weekday;
            case TimeItem.DAY:
                return ds1339.day;
            case TimeItem.MONTH:
                return ds1339.month;
            case TimeItem.YEAR:
                return ds1339.year;
        }
        return 0;
    }

    /**
     * Set Alarm, RepeadMode, Hour, Minute, Second, Day, Weekday
     */
    //% group="Alarm"
    //% weight=100
    //% blockId=rtcSetAlarmWeek block="set alarm %mode hour %hour minute %minu second %sec %enable || day %day weekday %weekday"
    //% hour.defl=0 hour.min=0 hour.max=23
    //% minu.defl=0 minu.min=0 minu.max=59
    //% sec.defl=0 sec.min=0 sec.max=59
    //% enable.shadow="toggleOnOff" enable.defl=true
    //% day.defl=1 day.min=1 day.max=31
    //% expandableArgumentMode="toggle"
    export function setAlarm(mode: RepeatMode, hour: number, minu: number, sec: number, enable: boolean, day?: number, weekday?: WeekItem) {
        ds1339.alarmHour = hour;
        ds1339.alarmMinute = minu;
        ds1339.alarmSecond = sec;
        ds1339.alarmRepeatMode = mode;
        
        if (mode == RepeatMode.EVERYMONTH) {
            ds1339.alarmDay = day;
        } else if (mode == RepeatMode.EVERYWEEK) {
            ds1339.alarmWeekday = weekday;
        }

        ds1339.alarmInt = enable;
    }

    /**
     * Set Alarm Week, Hour, Minute, Second
     */
    export function setAlarmWeekday(week: WeekItem, hour: number, minu: number, sec: number, enable: boolean) {
        ds1339.alarmWeekday = week;
        ds1339.alarmHour = hour;
        ds1339.alarmMinute = minu;
        ds1339.alarmSecond = sec;

        ds1339.alarmInt = enable;
    }

    /**
     * Set Alarm Date, Hour, Minute, Second
     */
    export function setAlarmDay(date: number = 1, hour: number, minu: number, sec: number, enable: boolean) {
        ds1339.alarmDay = date;
        ds1339.alarmHour = hour;
        ds1339.alarmMinute = minu;
        ds1339.alarmSecond = sec;

        ds1339.alarmInt = enable;
    }

    /**
     * Get Alarm Repeat Mode
     */
    //% weight=95
    //% group="Alarm"
    //% blockId=rtcGetAlarmRepeatMode block="alarm repeat mode"
    export function getAlarmRepeatMode(): RepeatMode {
        return ds1339.alarmRepeatMode;
    }

    //% weight=94
    //% group="Alarm"
    //% blockId=repeat_mode_enum block="%arg"
    export function repeatModeEnumShim(arg: RepeatMode): RepeatMode {
        return arg;
    }

    /**
     * Run some code when Alarm Interupt
     */
    //% weight=99 blockGap=8 help=controller/button/on-event
    //% blockId=alarminteruptonevent block="on alarmed"
    //% group="Alarm"
    export function onEvent(handler: () => void) {
        pins.AlarmIntPin.setPull(PinPullMode.PullUp);
        pins.AlarmIntPin.onEvent(PinEvent.Fall, handler);
    }

    /**
     * Clear Alarm Status
     */
    //% weight=98
    //% blockId=clearalarmstatus block="clear alarm status"
    //% group="Alarm"
    export function clearAlarmStatus() {
        ds1339.clearAlarmIntStatus();
    }

    /**
     * Read string format alarm.
     */
    //% group="Alarm"
    //% weight=96
    //% blockId=rtc_read_format_alarm block="string format alarm %format "
    //% format.defl="hh:mm"
    //% help=rtc/read-format-alarm
    export function stringFormatAlarm(format: string): string {
        const weekList = [
            'Monday',
            'Tuesday',
            'Wednesday',
            'Thursday',
            'Friday',
            'Saturday',
            'Sunday'
        ];
        const weekListAbbr = [
            'Mon.',
            'Tue.',
            'Wed.',
            'Thu.',
            'Fri.',
            'Sat.',
            'Sun.'
        ];

        let date = ds1339.alarmDay;
        let hours = ds1339.alarmHour;
        let minutes = ds1339.alarmMinute;
        let seconds = ds1339.alarmSecond;
        let week = ds1339.alarmWeekday;

        let dateStr = date >= 10 ? date.toString() : ('0' + date);
        let hoursStr = hours >= 10 ? hours.toString() : ('0' + hours);
        let minutesStr = minutes >= 10 ? minutes.toString() : ('0' + minutes);
        let secondsStr = seconds >= 10 ? seconds.toString() : ('0' + seconds);

        const mask = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE);

        if (mask & 0x40) {
            if (week > 0 && week <= 7) {
                if (format.indexOf('WWW') !== -1) {
                    format = format.replace('WWW', weekList[week - 1]);
                } else {
                    format = format.replace('WW', weekListAbbr[week - 1]);
                }
            }
        } else {
            format = format.replace('DD', dateStr);
        }

        format = format.replace('hh', hoursStr);
        format = format.replace('mm', minutesStr);
        format = format.replace('ss', secondsStr);

        return format;
    }

    /**
     * Read rtc alarm item.
     */
    //% group="Alarm" 
    //% weight=97
    //% blockId=rtc_read_alarm block="alarm %item"
    //% help=rtc/read-alarm
    export function alarm(item: AlarmItem = AlarmItem.SECOND): number {
        const mask = pins.i2cReadRegister(DS1339_I2C_ADDRESS, REG_DS1339_ALARM1_DAYDATE);

        switch (item) {
            case AlarmItem.SECOND:
                return ds1339.alarmSecond;
            case AlarmItem.MINUTE:
                return ds1339.alarmMinute;
            case AlarmItem.HOUR:
                return ds1339.alarmHour;
            case AlarmItem.WEEKDAY:
                if (mask & 0x40) {
                    return ds1339.alarmWeekday;
                } else {
                    return undefined;
                }
            case AlarmItem.DAY:
                if (mask & 0x40) {
                    return undefined;
                } else {
                    return ds1339.alarmDay;
                }
        }
        return 0;
    }

    /**
     * Read rtc alarm int.
     */
    //% group="Alarm" 
    //% weight=93
    //% blockId=rtc_read_alarm_int block="is alarm on"
    //% help=rtc/read-alarm-int
    export function isAlarm(): boolean {
        return ds1339.alarmInt;
    }
    
    function bin2bcd(v: number) {
        return ((v / 10) << 4) + (v % 10);
    }

    /**
     * Set Time
     */
    //% weight=97
    //% blockId=settime block="set time year %year month %month day %day weekday %weekday hour %hour minute %minute second %second"
    //% year.defl=2021
    //% month.defl=1 month.min=1 month.max=12
    //% day.defl=1 day.min=1 day.max=31
    //% hour.defl=0 hour.min=0 hour.max=23
    //% minute.defl=0 minute.min=0 minute.max=59
    //% second.defl=0 second.min=0 second.max=59
    //% group="Time"
    export function setTime(year: number, month: number, day: number, weekday: WeekItem, hour: number, minute: number, second: number) {
        let buf = pins.createBuffer(8);

        buf[0] = 0x00;
        buf[1] = bin2bcd(second);
        buf[2] = bin2bcd(minute);
        buf[3] = bin2bcd(hour);
        buf[4] = bin2bcd(weekday);
        buf[5] = bin2bcd(day);
        buf[6] = bin2bcd(month);
        buf[7] = bin2bcd(year);
        
        pins.i2cWriteBuffer(DS1339_I2C_ADDRESS, buf);
    }
}