MMM-VietNamEventsCalendar

This module are upgraded from default module calendar and has more powerful features:

Google Calendar:

• Display more than 1 google calendar
• Can change color, and title name for each google calendar
• Button to switch between calendars
• Send alert notification if event will happen within a time (default 5')
• Play alert sound if event will happen within a time (default 5s)
• Refresh all google calendars after a time (default 1')

Viet Nam Calendar

• Show VietNam and international events in a month (You can change to your country events)
• Show corresponding lunar events in a month
• Show/hide lunar date of events
• You can add your personal events, and they only show in current month in VietNam calendar area
• You can change color for VietNam Calendar

SCREENSHOT

INSTALLATION

cd ~/MagicMirror/modules
git clone https://github.com/phungorquan/MMM-VietNamEventsCalendar.git

UPDATE

TIP: YOU NEED TO SAVE YOUR ALL CHANGES BEFORE UPDATE

• Use gitk to show what you changed with UI tracking from git
• You have to download gitk with command: sudo apt install gitk before use gitk

UPDATE COMMANDS After you saved your all changes, then just do 2 commands below:

git reset --hard HEAD
git pull

Now you can copy your change into new version :D

DEFAULT CONFIG

To use this module, add below config into the modules array in the config/config.js file.

{
    module: "MMM-VietNamEventsCalendar",
    position: "top_left",
    config: {
        lunarColor: "LightGreen",
        calendars: [
	{
            url: "https://calendar.google.com/calendar/ical/anhquantong77%40gmail.com/public/basic.ics",
            color: "Violet",
            title: "Google lịch của anhquantong77 nha"
        }, 
	{
            url: "https://calendar.google.com/calendar/ical/quan.ng0anhin98%40gmail.com/public/basic.ics",
            color: "Yellow",
            title: "Google lịch của quan.ng0anhin98 nè"
        }],
        personalDateEvent:[
        {
            day: 7,
            month: 7,
            title: "Xiu BirthDay :D"
        }]
    }
}

CONFIGURATION OPTIONS

Option	Type	Possible Values	Default Value	Description
maximumEntries	int	0 - 100	10	The maximum number of events, affect both (Google,VNevents).
maximumNumberOfDays	int	365, 366	365	The maximum number of days in the future.
maxTitleLength	int	10 - 50	20	The maximum title length.
maxTitleLines	int	0 - 10	3	The maximum number of lines a title will wrap vertically before being cut (Only enabled if wrapEvents is also enabled).
wrapEvents	bool	true, false	true	Wrap event titles to multiple lines. Breaks lines at the length defined by maxTitleLength.
fetchInterval	int	1000 - 86400000	60000 (1')	How often does the content needs to be fetched? (Milliseconds).
animationSpeed	int	0 - 5000	500 (0.5s)	Speed of the update animation. (Milliseconds).
tableClass	String	xsmall, small, medium, large, xlarge	xsmall	Name of the classes from main.css.
displayPageIndicator	bool	true, false	true	Display page indicator to inform user which page they are standing (current page / last page).
displaySwitchBtn	bool	true, false	true	Display button to switch calendars (pre/next).
moveToPageAfterInterval	bool	true, false	true	Allow display to a page after fetchInterval.
pageAfterInterval	int	0 - (google calendar quantity + 1)	0 (All - first page)	Display at page after fetchInterval. This number follow Array[] rule, start at index 0
displayEndTime	bool	true, false	true	Allow display end time of google calender events.
dateEndFormat	String	See Moment.js	"LT(DD/MM)"	Format to use for the date of events when using absolute dates. (version <= 2.16.0) From version 2.16.0, this option will be used to format absolute and relative dates. (e.g. DD/MM/YY to change from the default MM/DD/YYYY).
colored	bool	true, false	true	Allow color google calendar events.
defaultColor	String	HEX, RGB or RGBA values (#efefef, rgb(242,242,242), rgba(242,242,242,0.5))	"White"	Default color of Google Calendar events.
durationWillAlert	int	1000 - 86400000	300000 (5')	If your event come within this time, your alert will be shown
alertSoundFile	String	See in resources folder	ClearAnnouce.wav	Sound alert files will be played when event is coming. See files in resources folder or download here
alertSoundTimer	int	1000 - 86400000	5000 (5s)	Timer to play alert sound and show notification
displayLocation	bool	true, false	true	Allow show location of google calendar events.
lunarColor	String	HEX, RGB or RGBA values (#efefef, rgb(242,242,242), rgba(242,242,242,0.5))	"LightGreen"	Color of VietNam, Personal events.
displayLunarEvents	bool	true, false	true	Display VietNam, Personal events.
displayLunarDate	bool	true, false	true	Display VietNam, Personal lunar time.
displayPersonalEvents	bool	true, false	true	Display Personal events.

CALENDARS OPTIONS

Option	Type	Possible Values	Default Value	Description
calendars	[]	See calendar configuration below	An example calendar	The list of calendars.
url	String	See url configuration below	Any public accessible .ical calendar	The url of the calendar .ical. This property is required.
color	String	HEX, RGB or RGBA values (#efefef, rgb(242,242,242), rgba(242,242,242,0.5))	"Violet"	Color of Google Calendar events.
title	String	Custom google calendar name	Your calendar name	You can put your calendar name.

PERSONAL DATE EVENT OPTIONS

Option	Type	Possible Values	Default Value	Description
personalDateEvent	[]	See personalDateEvent configuration below	An example calendar	The list of personalDateEvent.
day	int,String	1-31	Your event date	Your event date.
month	int,String	1-12	Your event month	Your event month.
title	String	Your event name	Your event name	You can put your event name.

NOTIFICATIONS

The following is the list of notifications that MMM-pages will handle:

Notification	Payload type	Description
PREVIOUS_CALENDAR	None	Switch to next calendar.
NEXT_CALENDAR	None	Switch to previous calendar.
SWITCH_TO_ALL_CALENDAR	None	Switch to page which include all calendars.

FILES DESCRIPTION

Files and folders	Description
include/VietNamEvents.js	Edit VietNam events
resources	Contain resource file (.wav, .png)
src/calendarfetcher.js	Fetch google calendar (I copied from module calendar)
src/UtilsChecking.js	Contain functions to check calendars (personal calendar, google calendar)
src/VietNamCal.js	Contain functions to process DL,AL,...
translation/vi.json	Translation files
MMM-VietNamEventsCalendar.css	Contain layout definition of elements
MMM-VietNamEventsCalendar.js	Handle module

EVENTS:

1. Tết Dương lịch
2. Ngày Sinh viên Học sinh VN
3. Tết ông Công ông Táo
4. Mùng 1 Tết Nguyên Đán
5. Mùng 2 Tết Nguyên Đán
6. Mùng 3 Tết Nguyên Đán
7. Ngày thành lập ĐCSVN
8. Tết Nguyên Tiêu
9. Ngày Lễ tình nhân Valentine
10. Ngày Thầy thuốc VN
11. Quốc tế Phụ Nữ
12. Quốc tế Hạnh phúc
13. Ngày thành lập ĐTNCS HCM
14. Tết Hàn thực
15. Ngày Thể thao VN
16. Ngày Cá tháng Tư
17. Giỗ tổ Hùng Vương
18. Lễ Phục Sinh
19. Ngày Sách VN
20. Ngày Trái đất
21. Ngày thống nhất đất nước
22. Quốc tế Lao Động
23. Ngày chiến thắng ĐBP
24. Lễ Phật Đản
25. Ngày của Mẹ
26. Quốc tế Gia đình
27. Ngày thành lập ĐTNTP HCM
28. Ngày sinh Chủ tịch HCM
29. Quốc tế Thiếu Nhi
30. Ngày Môi trường Thế Giới
31. Ngày BH ra đi tìm đường cứu nước
32. Ngày của Cha
33. Tết Đoan Ngọ
34. Ngày Gia đình VN
35. Ngày Dân số Thế Giới
36. Ngày Thương binh liệt sĩ
37. Ngày CMT8 thành công
38. Quốc Khánh
39. Lễ Vu Lan
40. Quốc tế Người cao tuổi
41. Tết Trung thu
42. Ngày Doanh nhân VN
43. Ngày thành lập Hội Phụ nữ VN
44. Halloween Lễ hội hoá trang
45. Quốc tế Nam giới
46. Ngày Nhà giáo VN
47. Lễ tạ ơn
48. Black Friday
49. Quốc tế phòng chống AIDS
50. Quốc tế người khuyết tật
51. Quốc tế nhân quyền
52. Ngày thành lập QĐND VN
53. Noel Lễ Giáng Sinh