GMail-ATOM-Sensor
Scope
This is a Luup plugin to check your GMail Atom feed for unread emails associated with specific custom labels
Luup (Lua-UPnP) is a software engine which incorporates Lua, a popular scripting language, and UPnP, the industry standard way to control devices. Luup is the basis of a number of home automation controllers e.g. Micasaverde Vera, Vera Home Control, OpenLuup.
Compatibility
This plug-in has been tested on the Ezlo Vera Home Control system. You need a Gmail account that is not set up for OAUTH, it will require some security settings turned off to just allow username/password access Custom labels (e.g Vera) can be created and used - > https://hiverhq.com/blog/gmail-labels System labels (e.g ^i or ^all ) can also be used, the availble option are here - > https://developers.google.com/gmail/android/com/google/android/gm/contentprovider/GmailContract.Labels.LabelCanonicalNames
** Don't use this for any sensitive information, i am just using it for generic alert messages, and the account name has no personally identifiable information
Features
It supports the following functionality:
- Creation of a device in UI to show your unread email of a specific Gmail label
- Periodically updates the number of unread emails based on the
- Multiple labels can be given, comma seperated, but only one displayed
Still to be added..
- Add a button to refresh labels on demand
- Add default variable to show other system label information
- other fixes/updates
Imstallation / Usage
This installation assumes you are running the latest version of Vera software.
- Upload the icon mail.png file to the appropriate storage location on your controller. For Vera that's
/www/cmh/skins/default/icons - Upload the .xml and .json file in the repository to the appropriate storage location on your controller. For Vera that's via Apps/Develop Apps/Luup files/
- Create the decice instance via the appropriate route. For Vera that's Apps/Develop Apps/Create Device/ and putting "D_GMailAtom1.xml" into the Upnp Device Filename box.
- Reload luup to establish the device and then reload luup again (just to be sure) and you should be good to go.
Quick Configuration script
After you have added the files and created the device, the following is a quick way to configure the device, simply update the following and run it via Apps/Develop Apps/Test Code
local DEVICE = 1194 -- Device ID assigned on Vera
local ATOM_SERV = "urn:nodecentral-net:serviceId:GMailAtom1"
local USERNAME = "your_email_address@gmail.com"
local PASSWORD = "your_password"
local CUSTOM_LABELS = "Vera, ^all, " -- Label(s) to be checked
local DISPLAY_LABEL = "Vera" -- Label and associated count you want to appear on the UI
luup.variable_set(ATOM_SERV, "USERNAME", USERNAME, DEVICE)
luup.variable_set(ATOM_SERV, "PASSWORD", PASSWORD, DEVICE)
luup.variable_set(ATOM_SERV, "CUSTOM_LABELS", CUSTOM_LABELS, DEVICE)
luup.variable_set(ATOM_SERV, "DISPLAY_LABEL", DISPLAY_LABEL, DEVICE)
luup.reload()
Limitations
While it has been tested, it has not been tested very much and may not support other related devices or those running different firmware.
Buy me a coffee
If you choose to use/customise or just like this plug-in, feel free to say thanks with a coffee or two.. (God knows I drank enough working on this :-))
Screenshots
Once installed, you should see the device listed with your display label
License
Copyright © 2021 Chris Parker (nodecentral)
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses