This is a Luup plugin to keep an eye on your Paperless-ngx instance - https://github.com/paperless-ngx/paperless-ngx
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.
This plug-in has been tested on the Ezlo Vera Home Control system. You need a Paperless-ngx instance running which you can access
It supports the following functionality:
- Creation of a device in the UI to show your Paperless-ngx configuration
- Periodically updates the number of documents etc
Still to be added..
- Add a button to refresh labels on demand
- Add default variable to show other system label information
- other fixes/updates
This installation assumes you are running the latest version of Vera software.
- You have the option with this release to use the
D_paperless1_URL.jsonfile to pull the icons directly from the web, or if you prefer to have everything local, the you can use the standard .json and upload the error.png and documents.png files 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_xxxxxxxxx.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.
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 = 1210
local SERV = "urn:nodecentral-net:serviceId:Paperless1"
local Username = "yourusername"
local Password = "yourpassword"
local IpPort = "192.168.1.234:8777"
luup.variable_set(SERV, "Username", Username, DEVICE)
luup.variable_set(SERV, "Password", Password, DEVICE)
luup.variable_set(SERV, "IpPort", IpPort, DEVICE)
luup.reload()
While it has been tested, it has not been tested very much and may not support other related devices or those running different firmware.
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 :-))
Once installed, you should see the device listed with your display label
and when you access the tile, you will see details about your Paperless instance
Copyright © 2022 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