forked from massivebox/ecodash
First commit
This commit is contained in:
commit
82bba66fd6
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
config.json
|
||||||
|
cache.json
|
||||||
|
go.sum
|
8
.idea/.gitignore
vendored
Normal file
8
.idea/.gitignore
vendored
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
# Default ignored files
|
||||||
|
/shelf/
|
||||||
|
/workspace.xml
|
||||||
|
# Editor-based HTTP Client requests
|
||||||
|
/httpRequests/
|
||||||
|
# Datasource local storage ignored files
|
||||||
|
/dataSources/
|
||||||
|
/dataSources.local.xml
|
9
.idea/ecodash.iml
Normal file
9
.idea/ecodash.iml
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<module type="WEB_MODULE" version="4">
|
||||||
|
<component name="Go" enabled="true" />
|
||||||
|
<component name="NewModuleRootManager">
|
||||||
|
<content url="file://$MODULE_DIR$" />
|
||||||
|
<orderEntry type="inheritedJdk" />
|
||||||
|
<orderEntry type="sourceFolder" forTests="false" />
|
||||||
|
</component>
|
||||||
|
</module>
|
36
.idea/inspectionProfiles/Project_Default.xml
Normal file
36
.idea/inspectionProfiles/Project_Default.xml
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
<component name="InspectionProjectProfileManager">
|
||||||
|
<profile version="1.0">
|
||||||
|
<option name="myName" value="Project Default" />
|
||||||
|
<inspection_tool class="HttpUrlsUsage" enabled="true" level="WEAK WARNING" enabled_by_default="true">
|
||||||
|
<option name="ignoredUrls">
|
||||||
|
<list>
|
||||||
|
<option value="http://localhost" />
|
||||||
|
<option value="http://127.0.0.1" />
|
||||||
|
<option value="http://0.0.0.0" />
|
||||||
|
<option value="http://www.w3.org/" />
|
||||||
|
<option value="http://json-schema.org/draft" />
|
||||||
|
<option value="http://java.sun.com/" />
|
||||||
|
<option value="http://xmlns.jcp.org/" />
|
||||||
|
<option value="http://javafx.com/javafx/" />
|
||||||
|
<option value="http://javafx.com/fxml" />
|
||||||
|
<option value="http://maven.apache.org/xsd/" />
|
||||||
|
<option value="http://maven.apache.org/POM/" />
|
||||||
|
<option value="http://www.springframework.org/schema/" />
|
||||||
|
<option value="http://www.springframework.org/tags" />
|
||||||
|
<option value="http://www.springframework.org/security/tags" />
|
||||||
|
<option value="http://www.thymeleaf.org" />
|
||||||
|
<option value="http://www.jboss.org/j2ee/schema/" />
|
||||||
|
<option value="http://www.jboss.com/xml/ns/" />
|
||||||
|
<option value="http://www.ibm.com/webservices/xsd" />
|
||||||
|
<option value="http://activemq.apache.org/schema/" />
|
||||||
|
<option value="http://schema.cloudfoundry.org/spring/" />
|
||||||
|
<option value="http://schemas.xmlsoap.org/" />
|
||||||
|
<option value="http://cxf.apache.org/schemas/" />
|
||||||
|
<option value="http://primefaces.org/ui" />
|
||||||
|
<option value="http://tiles.apache.org/" />
|
||||||
|
<option value="http://" />
|
||||||
|
</list>
|
||||||
|
</option>
|
||||||
|
</inspection_tool>
|
||||||
|
</profile>
|
||||||
|
</component>
|
8
.idea/misc.xml
Normal file
8
.idea/misc.xml
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="SwUserDefinedSpecifications">
|
||||||
|
<option name="specTypeByUrl">
|
||||||
|
<map />
|
||||||
|
</option>
|
||||||
|
</component>
|
||||||
|
</project>
|
8
.idea/modules.xml
Normal file
8
.idea/modules.xml
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project version="4">
|
||||||
|
<component name="ProjectModuleManager">
|
||||||
|
<modules>
|
||||||
|
<module fileurl="file://$PROJECT_DIR$/.idea/ecodash.iml" filepath="$PROJECT_DIR$/.idea/ecodash.iml" />
|
||||||
|
</modules>
|
||||||
|
</component>
|
||||||
|
</project>
|
14
Dockerfile
Normal file
14
Dockerfile
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
FROM golang:1.19
|
||||||
|
|
||||||
|
RUN mkdir -p /app
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
ADD . /app
|
||||||
|
|
||||||
|
RUN rm -rf go.mod go.sum config.json cache.json; \
|
||||||
|
touch config.json; \
|
||||||
|
go mod init ecodash; \
|
||||||
|
go mod tidy
|
||||||
|
RUN go build -o app .
|
||||||
|
|
||||||
|
CMD ["./app"]
|
674
LICENSE
Normal file
674
LICENSE
Normal file
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
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 <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
103
README.md
Normal file
103
README.md
Normal file
|
@ -0,0 +1,103 @@
|
||||||
|
# 🌿 EcoDash
|
||||||
|
|
||||||
|
EcoDash is a simple way to show your users how much your server consumes.
|
||||||
|
It's intended as a medium of transparency, that gives your users an idea about the consumption of your machine. It's not meant to be 100% accurate.
|
||||||
|
|
||||||
|
You can see it in action here: https://ecodash.massivebox.net
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- A working HomeAssistant installation
|
||||||
|
- An energy consumption sensor, such as a [smart plug](https://www.aliexpress.com/item/1005003188500978.html), to which your server is plugged in and connected.
|
||||||
|
- All hardware that is
|
||||||
|
- CO2 Signal added as integration into HomeAssistant
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
#### Using Docker run:
|
||||||
|
```
|
||||||
|
touch config.json
|
||||||
|
docker run -v ./config.json:/app/config.json --name ecodash -p 8080:80 gitea.massivebox.net/massivebox/ecodash
|
||||||
|
```
|
||||||
|
This will open the container on port 8080. Replace "8080" in the command with whatever number you want to open that specific port.
|
||||||
|
|
||||||
|
#### Using Docker Compose:
|
||||||
|
Create a file `docker-compose.yml` with the following content:
|
||||||
|
```
|
||||||
|
version: '3'
|
||||||
|
services:
|
||||||
|
ecodash:
|
||||||
|
container_name: ecodash
|
||||||
|
image: gitea.massivebox.net/massivebox/ecodash
|
||||||
|
ports:
|
||||||
|
- '8080:80'
|
||||||
|
volumes:
|
||||||
|
- ./config.json:/app/config.json
|
||||||
|
restart: always
|
||||||
|
|
||||||
|
```
|
||||||
|
Run the container with
|
||||||
|
```
|
||||||
|
touch config.json
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
This will open the container on port 8080. Replace "8080" in the file with whatever number you want to open that specific port.
|
||||||
|
|
||||||
|
#### Using the binary
|
||||||
|
Grab a binary from the Releases page and run it. You can use the `PORT` environment variable to override the default port (80).
|
||||||
|
|
||||||
|
## Set up
|
||||||
|
|
||||||
|
As soon as you navigate to the container's exposed port, you will see the admin dashboard, there you will have to fill all fields to get EcoDash running.
|
||||||
|
|
||||||
|
- **HomeAssistant's base URL**: the base URL which you use to access HomeAssistant on your server. It should be something like `http://INTERNAL_IP_ADDRESS:8123/` or `https://homeassistant.youdomain.com/`.
|
||||||
|
- **HomeAssistant's API Key:** Get it by going into your HomeAssistant profile settings (at `http://HOMEASSISTANT-BASE-URL/profile`) -> Create Long Lived Access Token (at the very bottom of the page) -> Insert a name -> Copy the string it gives you
|
||||||
|
- **Polled Smart Energy Summation entity ID:** After your plug is added in HomeAssistant, get it in Overview -> look for an entity called like "[Name of your plug] Polledsmartenergysummation" -> Settings -> Copy the Entity ID. Check that the unit of measurement in the "Info" tab is kWh.
|
||||||
|
- **CO2 signal Grid fossil fuel percentage entity ID**: Get it in Settings -> Devices and Integrations -> Add Integration -> CO2 Signal -> Get your token from the website -> CO2 signal Grid fossil fuel percentage -> Settings -> Copy the Entity ID. Check that the unit of measurement in the "Info" tab is %.
|
||||||
|
- **Admin username and password** don't need to be the credentials to HomeAssistant! They are the credentials to log into the admin panel.
|
||||||
|
|
||||||
|
If you've just added your energy meter into HomeAssistant, note that it will take eight days for EcoDash to show meaningful data.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
If something isn't working, you can find some help here:
|
||||||
|
- [Matrix support room](https://matrix.to/#/#support:massivebox.net)
|
||||||
|
- [Issues page](./issues)
|
||||||
|
- [Contact me](https://massivebox.net/contact.html)
|
||||||
|
|
||||||
|
## The road ahead
|
||||||
|
|
||||||
|
EcoDash is currently released as a minimum viable product, still far from completion. Here's a non-extensive, unordered list of the changes I want to make.
|
||||||
|
|
||||||
|
- Adding support for energy returns (like solar panels)
|
||||||
|
- Supporting hot reload, removing the need to restart EcoDash each time the settings are changed
|
||||||
|
- Improving clarity for when data is missing
|
||||||
|
- Making FossilFuel Percentage optional and adding other sources
|
||||||
|
- Supporting energy consumption readings from internal sensors
|
||||||
|
- Adding some way to change header/footer links directly from the admin panel
|
||||||
|
- Eventually being completely HomeAssistant-independent
|
||||||
|
- Adding Woodpecker CI
|
||||||
|
- Organizing branches and releases better
|
||||||
|
- Moving documentation to a wiki and expanding it
|
||||||
|
- Extensively documenting the theming capabilities of EcoDash
|
||||||
|
- Publishing some alternative themes
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
```
|
||||||
|
EcoDash
|
||||||
|
Copyright (C) 2022 MassiveBox
|
||||||
|
|
||||||
|
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 <https://www.gnu.org/licenses/>.
|
||||||
|
```
|
239
api.go
Normal file
239
api.go
Normal file
|
@ -0,0 +1,239 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"log"
|
||||||
|
"math"
|
||||||
|
"net/http"
|
||||||
|
"net/url"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type HistoryResult [][]struct {
|
||||||
|
State string `json:"state"`
|
||||||
|
LastUpdated time.Time `json:"last_updated"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) queryHistory(entityID string, startTime, endTime time.Time) (HistoryResult, error) {
|
||||||
|
|
||||||
|
req, err := http.NewRequest("GET", config.HomeAssistant.BaseURL+
|
||||||
|
"/api/history/period/"+url.QueryEscape(startTime.Format(time.RFC3339))+
|
||||||
|
"?filter_entity_id="+entityID+
|
||||||
|
"&end_time="+url.QueryEscape(endTime.Format(time.RFC3339)), /*+
|
||||||
|
"&minimal_response",*/nil)
|
||||||
|
if err != nil {
|
||||||
|
return HistoryResult{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Add("Authorization", "Bearer "+config.HomeAssistant.ApiKey)
|
||||||
|
client := &http.Client{}
|
||||||
|
|
||||||
|
resp, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return HistoryResult{}, err
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
if resp.StatusCode != 200 {
|
||||||
|
return HistoryResult{}, errors.New("got a non-200 status code. Check the correctness of sensors IDs -" + resp.Status)
|
||||||
|
}
|
||||||
|
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return HistoryResult{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var result HistoryResult
|
||||||
|
err = json.Unmarshal(body, &result)
|
||||||
|
if err != nil {
|
||||||
|
return result, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return result, nil
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
type DayData struct {
|
||||||
|
DayNumber int
|
||||||
|
DayTime time.Time
|
||||||
|
Measurements int
|
||||||
|
Value float32
|
||||||
|
High float32
|
||||||
|
Low float32
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) historyAverageAndConvertToGreen(entityID string, startTime, endTime time.Time) ([]DayData, error) {
|
||||||
|
|
||||||
|
history, err := config.queryHistory(entityID, startTime, endTime)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var days []DayData
|
||||||
|
|
||||||
|
for _, historyChange := range history[0] {
|
||||||
|
val, err := strconv.ParseFloat(historyChange.State, 32)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
value := float32(val)
|
||||||
|
var found bool
|
||||||
|
dayNo := historyChange.LastUpdated.Local().Day()
|
||||||
|
for key, day := range days {
|
||||||
|
if dayNo == day.DayNumber {
|
||||||
|
found = true
|
||||||
|
day.Value += value
|
||||||
|
day.Measurements++
|
||||||
|
days[key] = day
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
days = append(days, DayData{
|
||||||
|
DayNumber: dayNo,
|
||||||
|
DayTime: historyChange.LastUpdated.Local(),
|
||||||
|
Measurements: 1,
|
||||||
|
Value: value,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for key, day := range days {
|
||||||
|
// by using 100 - value we get the percentage of green energy instead of the percentage of fossil-generated energy
|
||||||
|
day.Value = 100 - (day.Value / float32(day.Measurements))
|
||||||
|
days[key] = day
|
||||||
|
}
|
||||||
|
|
||||||
|
days = fillMissing(days)
|
||||||
|
|
||||||
|
return days, nil
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) historyDelta(entityID string, startTime, endTime time.Time) ([]DayData, error) {
|
||||||
|
|
||||||
|
history, err := config.queryHistory(entityID, startTime, endTime)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var days []DayData
|
||||||
|
|
||||||
|
for _, historyChange := range history[0] {
|
||||||
|
if historyChange.State != "off" {
|
||||||
|
val, err := strconv.ParseFloat(historyChange.State, 32)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
value := float32(val)
|
||||||
|
var found bool
|
||||||
|
dayNo := historyChange.LastUpdated.Local().Day()
|
||||||
|
for key, day := range days {
|
||||||
|
if dayNo == day.DayNumber {
|
||||||
|
found = true
|
||||||
|
if value > day.High {
|
||||||
|
day.High = value
|
||||||
|
}
|
||||||
|
if value < day.Low || day.Low == 0 {
|
||||||
|
day.Low = value
|
||||||
|
}
|
||||||
|
days[key] = day
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
days = append(days, DayData{
|
||||||
|
DayNumber: dayNo,
|
||||||
|
DayTime: historyChange.LastUpdated.Local(),
|
||||||
|
Value: value,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for key, day := range days {
|
||||||
|
day.Value = day.High - day.Low
|
||||||
|
days[key] = day
|
||||||
|
}
|
||||||
|
|
||||||
|
days = fillMissing(days)
|
||||||
|
|
||||||
|
return days, nil
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func fillMissing(days []DayData) []DayData {
|
||||||
|
|
||||||
|
var (
|
||||||
|
previousDay time.Time
|
||||||
|
defaultDay time.Time
|
||||||
|
previousValue float32
|
||||||
|
ret []DayData
|
||||||
|
currentTime = time.Now()
|
||||||
|
)
|
||||||
|
|
||||||
|
for key, day := range days {
|
||||||
|
|
||||||
|
if key != 0 {
|
||||||
|
|
||||||
|
if day.DayTime.Day() != previousDay.Add(24*time.Hour).Day() {
|
||||||
|
daysDiff := math.Trunc(day.DayTime.Sub(previousDay).Hours() / 24)
|
||||||
|
for i := 1; float64(i) < daysDiff; i++ {
|
||||||
|
fakeTime := previousDay.Add(time.Duration(24*i) * time.Hour)
|
||||||
|
ret = append(ret, DayData{
|
||||||
|
DayNumber: fakeTime.Day(),
|
||||||
|
DayTime: fakeTime,
|
||||||
|
Value: previousValue,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
ret = append(ret, day)
|
||||||
|
previousValue = day.Value
|
||||||
|
previousDay = day.DayTime
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// note that here previousDay is the last logged day
|
||||||
|
if previousDay == defaultDay {
|
||||||
|
return []DayData{}
|
||||||
|
}
|
||||||
|
|
||||||
|
if previousDay.Day() != currentTime.Day() {
|
||||||
|
daysDiff := math.Trunc(currentTime.Sub(previousDay).Hours() / 24)
|
||||||
|
for i := 1; float64(i) < daysDiff; i++ {
|
||||||
|
fakeTime := previousDay.Add(time.Duration(24*i) * time.Hour)
|
||||||
|
ret = append(ret, DayData{
|
||||||
|
DayNumber: fakeTime.Day(),
|
||||||
|
DayTime: fakeTime,
|
||||||
|
Value: previousValue,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(ret) < 8 {
|
||||||
|
shouldAdd := 8 - len(ret)
|
||||||
|
startDay := currentTime.Add(-time.Duration(24*len(ret)) * time.Hour)
|
||||||
|
for i := 0; i < shouldAdd; i++ {
|
||||||
|
fakeTime := startDay.Add(-time.Duration(24*i) * time.Hour)
|
||||||
|
ret = append([]DayData{
|
||||||
|
{
|
||||||
|
DayNumber: fakeTime.Day(),
|
||||||
|
DayTime: fakeTime,
|
||||||
|
Value: 0,
|
||||||
|
},
|
||||||
|
}, ret...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(ret) != 8 {
|
||||||
|
// oh shit
|
||||||
|
log.Panicln("You've found a logic bug! Open a bug report ASAP.")
|
||||||
|
}
|
||||||
|
|
||||||
|
return ret
|
||||||
|
|
||||||
|
}
|
67
cache.go
Normal file
67
cache.go
Normal file
|
@ -0,0 +1,67 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type CacheEntry struct {
|
||||||
|
Date string `json:"date""`
|
||||||
|
GreenEnergyPercentage float32 `json:"green_energy_percentage"`
|
||||||
|
PolledSmartEnergySummation float32 `json:"polled_smart_energy_summation"`
|
||||||
|
}
|
||||||
|
type CacheFile []CacheEntry
|
||||||
|
|
||||||
|
func (config Config) updateCache() {
|
||||||
|
|
||||||
|
now := time.Now()
|
||||||
|
h, m, s := now.Clock()
|
||||||
|
start := now.AddDate(0, 0, -7).Add(-(time.Duration(h)*time.Hour + time.Duration(m)*time.Minute + time.Duration(s)*time.Second))
|
||||||
|
|
||||||
|
greenEnergyPercentage, err := config.historyAverageAndConvertToGreen(config.Sensors.FossilPercentage, start, now)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println("Error updating cached data for FossilPercentage -" + err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
historyPolledSmartEnergySummation, err := config.historyDelta(config.Sensors.PolledSmartEnergySummation, start, now)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println("Error updating cached data for PolledSmartEnergySummation -" + err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
var cacheEntries []CacheEntry
|
||||||
|
for key, day := range greenEnergyPercentage {
|
||||||
|
cacheEntries = append(cacheEntries, CacheEntry{
|
||||||
|
Date: day.DayTime.Format("02/01"),
|
||||||
|
GreenEnergyPercentage: greenEnergyPercentage[key].Value,
|
||||||
|
PolledSmartEnergySummation: historyPolledSmartEnergySummation[key].Value,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
out, _ := json.Marshal(cacheEntries)
|
||||||
|
|
||||||
|
err = os.WriteFile("cache.json", out, 0666)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println("Error saving cached data to file -" + err.Error())
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func readCache() (CacheFile, error) {
|
||||||
|
|
||||||
|
data, err := os.ReadFile("cache.json")
|
||||||
|
if err != nil {
|
||||||
|
return CacheFile{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
var cache CacheFile
|
||||||
|
err = json.Unmarshal(data, &cache)
|
||||||
|
if err != nil {
|
||||||
|
return CacheFile{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return cache, nil
|
||||||
|
|
||||||
|
}
|
109
config.go
Normal file
109
config.go
Normal file
|
@ -0,0 +1,109 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"github.com/gofiber/fiber/v2"
|
||||||
|
"os"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Config struct {
|
||||||
|
HomeAssistant HomeAssistant `json:"home_assistant"`
|
||||||
|
Sensors Sensors `json:"sensors"`
|
||||||
|
Administrator Administrator `json:"administrator"`
|
||||||
|
Dashboard Dashboard `json:"dashboard"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type HomeAssistant struct {
|
||||||
|
BaseURL string `json:"base_url"`
|
||||||
|
ApiKey string `json:"api_key"`
|
||||||
|
}
|
||||||
|
type Sensors struct {
|
||||||
|
PolledSmartEnergySummation string `json:"polled_smart_energy_summation"`
|
||||||
|
FossilPercentage string `json:"fossil_percentage"`
|
||||||
|
}
|
||||||
|
type Administrator struct {
|
||||||
|
Username string `json:"username"`
|
||||||
|
PasswordHash string `json:"password_hash"`
|
||||||
|
}
|
||||||
|
type Dashboard struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Theme string `json:"theme"`
|
||||||
|
FooterLinks []Link `json:"footer_links"`
|
||||||
|
HeaderLinks []Link `json:"header_links"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func formatURL(url string) (string, error) {
|
||||||
|
|
||||||
|
// the URL we want is: protocol://hostname[:port] without a final /
|
||||||
|
|
||||||
|
if !strings.HasPrefix(url, "http://") && !strings.HasPrefix(url, "https://") {
|
||||||
|
url = "http://" + url
|
||||||
|
}
|
||||||
|
if strings.HasSuffix(url, "/") {
|
||||||
|
url = url[0 : len(url)-1]
|
||||||
|
}
|
||||||
|
|
||||||
|
test := regexp.MustCompile(`(?m)https?:\/\/[^/]*`).ReplaceAllString(url, "")
|
||||||
|
if test != "" {
|
||||||
|
return "", errors.New("HomeAssistant base URL is badly formatted")
|
||||||
|
}
|
||||||
|
|
||||||
|
return url, nil
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadConfig() (config Config, err error, isFirstRun bool) {
|
||||||
|
|
||||||
|
var defaultConfig = Config{}
|
||||||
|
defaultConfig.Dashboard.Theme = "default"
|
||||||
|
defaultConfig.Dashboard.Name = "EcoDash"
|
||||||
|
defaultConfig.Dashboard.HeaderLinks = append(defaultConfig.Dashboard.HeaderLinks, Link{
|
||||||
|
Label: "Admin",
|
||||||
|
Destination: "/admin",
|
||||||
|
}, Link{
|
||||||
|
Label: "Docs",
|
||||||
|
Destination: "https://gitea.massivebox.net/massivebox/ecodash",
|
||||||
|
NewTab: true,
|
||||||
|
Primary: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
data, err := os.ReadFile("config.json")
|
||||||
|
if err != nil {
|
||||||
|
// if the data file doesn't exist, we consider it a first run
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return defaultConfig, nil, true
|
||||||
|
}
|
||||||
|
return Config{}, err, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// if the data file is empty, we consider it as a first run
|
||||||
|
if string(data) == "" {
|
||||||
|
return defaultConfig, nil, true
|
||||||
|
}
|
||||||
|
|
||||||
|
var conf Config
|
||||||
|
err = json.Unmarshal(data, &conf)
|
||||||
|
if err != nil {
|
||||||
|
return Config{}, err, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return conf, nil, false
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// just a little utility function to SHA256 strings (for hashing passwords)
|
||||||
|
func hash(toHash string) string {
|
||||||
|
return fmt.Sprintf("%x", sha256.Sum256([]byte(toHash)))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) isAuthorized(c *fiber.Ctx) bool {
|
||||||
|
if config.Administrator.PasswordHash == "" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return c.Cookies("admin_username") == config.Administrator.Username && c.Cookies("admin_password_hash") == config.Administrator.PasswordHash
|
||||||
|
}
|
18
go.mod
Normal file
18
go.mod
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
module ecodash
|
||||||
|
|
||||||
|
go 1.17
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/gofiber/fiber/v2 v2.37.1
|
||||||
|
github.com/gofiber/template v1.7.1
|
||||||
|
github.com/robfig/cron/v3 v3.0.1
|
||||||
|
)
|
||||||
|
|
||||||
|
require (
|
||||||
|
github.com/andybalholm/brotli v1.0.4 // indirect
|
||||||
|
github.com/klauspost/compress v1.15.0 // indirect
|
||||||
|
github.com/valyala/bytebufferpool v1.0.0 // indirect
|
||||||
|
github.com/valyala/fasthttp v1.40.0 // indirect
|
||||||
|
github.com/valyala/tcplisten v1.0.0 // indirect
|
||||||
|
golang.org/x/sys v0.0.0-20220227234510-4e6760a101f9 // indirect
|
||||||
|
)
|
219
http.go
Normal file
219
http.go
Normal file
|
@ -0,0 +1,219 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"github.com/gofiber/fiber/v2"
|
||||||
|
"html/template"
|
||||||
|
"math"
|
||||||
|
"os"
|
||||||
|
"reflect"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Link struct {
|
||||||
|
Label string `json:"label"`
|
||||||
|
Destination string `json:"destination"`
|
||||||
|
NewTab bool `json:"new_tab"`
|
||||||
|
Primary bool `json:"primary"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Warning struct {
|
||||||
|
Header string
|
||||||
|
Body string
|
||||||
|
BodyHTML template.HTML
|
||||||
|
IsSuccess bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) getTemplateDefaults() map[string]interface{} {
|
||||||
|
return fiber.Map{
|
||||||
|
"DashboardName": config.Dashboard.Name,
|
||||||
|
"HeaderLinks": config.Dashboard.HeaderLinks,
|
||||||
|
"FooterLinks": config.Dashboard.FooterLinks,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) adminEndpoint(c *fiber.Ctx) error {
|
||||||
|
|
||||||
|
if c.Method() == "POST" {
|
||||||
|
|
||||||
|
if config.isAuthorized(c) { // here the user is submitting the form to change configuration
|
||||||
|
err := config.saveAdminForm(c)
|
||||||
|
if err != nil {
|
||||||
|
return config.renderAdminPanel(c, Warning{
|
||||||
|
Header: "An error occurred!",
|
||||||
|
Body: err.Error(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return config.renderAdminPanel(c, Warning{
|
||||||
|
Header: "Restart needed",
|
||||||
|
Body: "In order to apply changes, please <b>restart EcoDash</b>.<br>" +
|
||||||
|
"If you're running via Docker, click <a href='./restart'>here</a> to restart automatically.",
|
||||||
|
IsSuccess: true,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// here the user is trying to authenticate
|
||||||
|
if c.FormValue("username") == config.Administrator.Username && hash(c.FormValue("password")) == config.Administrator.PasswordHash {
|
||||||
|
c.Cookie(&fiber.Cookie{Name: "admin_username", Value: c.FormValue("username")})
|
||||||
|
c.Cookie(&fiber.Cookie{Name: "admin_password_hash", Value: hash(c.FormValue("password"))})
|
||||||
|
return config.renderAdminPanel(c)
|
||||||
|
}
|
||||||
|
return c.Render("login", fiber.Map{"Defaults": config.getTemplateDefaults(), "Failed": true}, "base")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
if config.isAuthorized(c) {
|
||||||
|
return config.renderAdminPanel(c)
|
||||||
|
}
|
||||||
|
return c.Render("login", fiber.Map{"Defaults": config.getTemplateDefaults()}, "base")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) renderAdminPanel(c *fiber.Ctx, warning ...Warning) error {
|
||||||
|
|
||||||
|
dirs, err := os.ReadDir("./templates")
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(warning) > 0 {
|
||||||
|
warning[0].BodyHTML = template.HTML(warning[0].Body)
|
||||||
|
return c.Render("admin", fiber.Map{
|
||||||
|
"Defaults": config.getTemplateDefaults(),
|
||||||
|
"Themes": dirs,
|
||||||
|
"Config": config,
|
||||||
|
"Warning": warning[0],
|
||||||
|
}, "base")
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.Render("admin", fiber.Map{
|
||||||
|
"Defaults": config.getTemplateDefaults(),
|
||||||
|
"Themes": dirs,
|
||||||
|
"Config": config,
|
||||||
|
}, "base")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) saveAdminForm(c *fiber.Ctx) error {
|
||||||
|
|
||||||
|
requiredFields := []string{"base_url", "api_key", "polled_smart_energy_summation", "fossil_percentage", "username", "theme", "name"}
|
||||||
|
for _, requiredField := range requiredFields {
|
||||||
|
if c.FormValue(requiredField) == "" {
|
||||||
|
return errors.New("Required field is missing: " + requiredField)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
form := Config{
|
||||||
|
HomeAssistant: HomeAssistant{ /*BaseURL to be filled later*/ ApiKey: c.FormValue("api_key")},
|
||||||
|
Sensors: Sensors{PolledSmartEnergySummation: c.FormValue("polled_smart_energy_summation"), FossilPercentage: c.FormValue("fossil_percentage")},
|
||||||
|
Administrator: Administrator{Username: c.FormValue("username") /*PasswordHash to be filled later*/},
|
||||||
|
Dashboard: Dashboard{Theme: c.FormValue("theme"), Name: c.FormValue("name"), HeaderLinks: config.Dashboard.HeaderLinks, FooterLinks: config.Dashboard.FooterLinks},
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.FormValue("keep_old_password") == "" {
|
||||||
|
form.Administrator.PasswordHash = hash(c.FormValue("password"))
|
||||||
|
} else {
|
||||||
|
form.Administrator.PasswordHash = config.Administrator.PasswordHash
|
||||||
|
}
|
||||||
|
|
||||||
|
fmtURL, err := formatURL(c.FormValue("base_url"))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
form.HomeAssistant.BaseURL = fmtURL
|
||||||
|
|
||||||
|
if reflect.DeepEqual(form, config) {
|
||||||
|
return errors.New("No changes from previous config.")
|
||||||
|
}
|
||||||
|
|
||||||
|
// in order to test if ha base URL, API key and entity IDs are correct we try fetching the devices history
|
||||||
|
_, err = form.queryHistory(form.Sensors.FossilPercentage, time.Now().Add(-5*time.Minute), time.Now())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
_, err = form.queryHistory(form.Sensors.PolledSmartEnergySummation, time.Now().Add(-5*time.Minute), time.Now())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
js, err := json.Marshal(form)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return os.WriteFile("config.json", js, 0666)
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func sevenDaysAverageExcludingCurrentDay(data []float32) float32 {
|
||||||
|
if len(data) == 0 {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
data = data[:len(data)-1]
|
||||||
|
var sum float32
|
||||||
|
for _, num := range data {
|
||||||
|
sum += num
|
||||||
|
}
|
||||||
|
var avg = sum / float32(len(data))
|
||||||
|
return float32(math.Floor(float64(avg)*100)) / 100
|
||||||
|
}
|
||||||
|
|
||||||
|
func (config Config) renderIndex(c *fiber.Ctx) error {
|
||||||
|
|
||||||
|
data, err := readCache()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
labels []string
|
||||||
|
greenEnergyConsumptionAbsolute []float32
|
||||||
|
greenEnergyPercents []float32
|
||||||
|
energyConsumptions []float32
|
||||||
|
)
|
||||||
|
|
||||||
|
for _, datum := range data {
|
||||||
|
labels = append(labels, datum.Date)
|
||||||
|
greenEnergyPercents = append(greenEnergyPercents, datum.GreenEnergyPercentage)
|
||||||
|
greenEnergyConsumptionAbsolute = append(greenEnergyConsumptionAbsolute, datum.GreenEnergyPercentage/100*datum.PolledSmartEnergySummation)
|
||||||
|
energyConsumptions = append(energyConsumptions, datum.PolledSmartEnergySummation)
|
||||||
|
}
|
||||||
|
|
||||||
|
perDayUsage := sevenDaysAverageExcludingCurrentDay(energyConsumptions)
|
||||||
|
|
||||||
|
return c.Render("index", fiber.Map{
|
||||||
|
"Defaults": config.getTemplateDefaults(),
|
||||||
|
"Labels": labels,
|
||||||
|
"GreenEnergyPercents": greenEnergyConsumptionAbsolute,
|
||||||
|
"EnergyConsumptions": energyConsumptions,
|
||||||
|
"GreenEnergyPercent": sevenDaysAverageExcludingCurrentDay(greenEnergyPercents),
|
||||||
|
"PerDayUsage": perDayUsage,
|
||||||
|
}, "base")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
func templateDivide(num1, num2 float32) template.HTML {
|
||||||
|
var (
|
||||||
|
isInDecimals bool
|
||||||
|
hasHitMeaningful bool
|
||||||
|
meaningfulDigits int
|
||||||
|
rounded []byte
|
||||||
|
num = num1 / num2
|
||||||
|
)
|
||||||
|
for _, char := range []byte(fmt.Sprintf("%v", num)) {
|
||||||
|
if (isInDecimals && char != '0') || hasHitMeaningful {
|
||||||
|
hasHitMeaningful = true
|
||||||
|
meaningfulDigits++
|
||||||
|
}
|
||||||
|
if char == '.' {
|
||||||
|
isInDecimals = true
|
||||||
|
}
|
||||||
|
rounded = append(rounded, char)
|
||||||
|
if meaningfulDigits == 3 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return template.HTML(rounded)
|
||||||
|
}
|
74
main.go
Normal file
74
main.go
Normal file
|
@ -0,0 +1,74 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/gofiber/fiber/v2"
|
||||||
|
"github.com/gofiber/template/html"
|
||||||
|
"github.com/robfig/cron/v3"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
|
||||||
|
config, err, isFirstRun := loadConfig()
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !isFirstRun {
|
||||||
|
cr := cron.New()
|
||||||
|
_, err = cr.AddFunc("@hourly", config.updateCache)
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
cr.Start()
|
||||||
|
config.updateCache()
|
||||||
|
}
|
||||||
|
|
||||||
|
engine := html.New("./templates/"+config.Dashboard.Theme, ".html")
|
||||||
|
engine.AddFunc("divide", templateDivide)
|
||||||
|
|
||||||
|
app := fiber.New(fiber.Config{
|
||||||
|
Views: engine,
|
||||||
|
})
|
||||||
|
|
||||||
|
app.Static("/assets", "./templates/"+config.Dashboard.Theme+"/assets")
|
||||||
|
|
||||||
|
app.Get("/", func(c *fiber.Ctx) error {
|
||||||
|
if isFirstRun {
|
||||||
|
c.Cookie(&fiber.Cookie{Name: "admin_username", Value: ""})
|
||||||
|
c.Cookie(&fiber.Cookie{Name: "admin_password_hash", Value: hash("")})
|
||||||
|
return config.renderAdminPanel(c)
|
||||||
|
}
|
||||||
|
return config.renderIndex(c)
|
||||||
|
})
|
||||||
|
|
||||||
|
app.Get("/accuracy-notice", func(c *fiber.Ctx) error {
|
||||||
|
return c.Render("accuracy-notice", fiber.Map{
|
||||||
|
"Defaults": config.getTemplateDefaults(),
|
||||||
|
}, "base")
|
||||||
|
})
|
||||||
|
|
||||||
|
app.All("/admin", config.adminEndpoint)
|
||||||
|
|
||||||
|
app.Get("/restart", func(c *fiber.Ctx) error {
|
||||||
|
if config.isAuthorized(c) {
|
||||||
|
go func() {
|
||||||
|
time.Sleep(time.Second)
|
||||||
|
os.Exit(1)
|
||||||
|
}()
|
||||||
|
return c.Render("restart", fiber.Map{
|
||||||
|
"Defaults": config.getTemplateDefaults(),
|
||||||
|
}, "base")
|
||||||
|
}
|
||||||
|
return c.Redirect("./", 307)
|
||||||
|
})
|
||||||
|
|
||||||
|
port := os.Getenv("PORT")
|
||||||
|
if port == "" {
|
||||||
|
port = "80"
|
||||||
|
}
|
||||||
|
log.Fatal(app.Listen(":" + port))
|
||||||
|
|
||||||
|
}
|
26
templates/default/accuracy-notice.html
Normal file
26
templates/default/accuracy-notice.html
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
<h1>Accuracy Notice</h1>
|
||||||
|
<p>
|
||||||
|
All the data reported in this dashboard is exclusively for reference. It's presented here with no guarantees of being
|
||||||
|
up-to-date or reliable.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h3>Energy consumption data</h3>
|
||||||
|
<p>
|
||||||
|
The energy consumption data reported in this dashboard has been obtained using unprofessional equipment, which lacks of
|
||||||
|
any kind of documentation about its precision.<br>
|
||||||
|
Don't take this data too seriously.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h3>Green energy percentage</h3>
|
||||||
|
<p>
|
||||||
|
The percentage of green energy is gathered using <a href="https://www.co2signal.com/">CO2Signal</a>'s API.<br>
|
||||||
|
The data reported might be estimated on historical data, and is exclusively
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h3>References for comparison table</h3>
|
||||||
|
<ul>
|
||||||
|
<li><b>Desk light:</b> calculated on a 3W 270 lumen lamp running for 24 hours = 0.072kWh</li>
|
||||||
|
<li><b>Washing machine:</b> estimated at an average of 0.66kWh <a href="https://inthewash.co.uk/washing-machines/how-much-electricity-does-a-washing-machine-use/">(source)</a></li>
|
||||||
|
<li><b>Oven:</b> calculated on a 2400W oven running for 30 minutes (the average time to bake a cake, according to my mom) = 1.2kWh</li>
|
||||||
|
<li><b>Bitcoin transaction</b>: estimated as 1300kWh <a href="https://digiconomist.net/bitcoin-energy-consumption">(source)</a></li>
|
||||||
|
</ul>
|
53
templates/default/admin.html
Normal file
53
templates/default/admin.html
Normal file
|
@ -0,0 +1,53 @@
|
||||||
|
<h1>Admin Panel</h1>
|
||||||
|
<p>Here you can edit all the configurations for EcoDash.</p>
|
||||||
|
|
||||||
|
{{if .Warning}}
|
||||||
|
<article class="card" style="background-color: {{if .Warning.IsSuccess}}#008000{{else}}#ff5050{{end}}; color: white">
|
||||||
|
<header>
|
||||||
|
<h3>{{.Warning.Header}}</h3>
|
||||||
|
</header>
|
||||||
|
<footer>
|
||||||
|
<p>{{.Warning.BodyHTML}}</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
{{end}}
|
||||||
|
|
||||||
|
<form action="./admin" method="POST">
|
||||||
|
|
||||||
|
<h3>HomeAssistant</h3>
|
||||||
|
<label>HomeAssistant's base URL <input type="text" name="base_url" value="{{.Config.HomeAssistant.BaseURL}}" required></label>
|
||||||
|
<label>HomeAssistant's API Key <input type="text" name="api_key" value="{{.Config.HomeAssistant.ApiKey}}" required></label>
|
||||||
|
|
||||||
|
<h3>Sensors</h3>
|
||||||
|
<label>Polled Smart Energy Summation entity ID <input type="text" name="polled_smart_energy_summation" value="{{.Config.Sensors.PolledSmartEnergySummation}}" required></label>
|
||||||
|
<label>CO2 signal Grid fossil fuel percentage entity ID <input type="text" name="fossil_percentage" value="{{.Config.Sensors.FossilPercentage}}" required></label>
|
||||||
|
|
||||||
|
<h3>Admin account</h3>
|
||||||
|
<label>Username <input type="text" name="username" value="{{.Config.Administrator.Username}}" required></label>
|
||||||
|
{{if .Config.Administrator.PasswordHash}}
|
||||||
|
<label>
|
||||||
|
<input type="checkbox" name="keep_old_password" onchange="toggle_password_edit()">
|
||||||
|
<p class="checkable">Keep the old password</p>
|
||||||
|
</label>
|
||||||
|
{{end}}
|
||||||
|
<label>Password <input type="password" name="password" id="password" required></label>
|
||||||
|
|
||||||
|
<h3>Personalization</h3>
|
||||||
|
<label>Theme
|
||||||
|
<select name="theme">
|
||||||
|
{{range .Themes}}
|
||||||
|
<option value="{{.Name}}">{{.Name}}</option>
|
||||||
|
{{end}}
|
||||||
|
</select>
|
||||||
|
</label>
|
||||||
|
<label>Dashboard name <input type="text" name="name" value="{{.Config.Dashboard.Name}}"></label>
|
||||||
|
<input type="submit" placeholder="Submit" style="margin-top: 2em; width: 100%">
|
||||||
|
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
function toggle_password_edit() {
|
||||||
|
const psw_field = document.getElementById('password');
|
||||||
|
psw_field.disabled = !psw_field.disabled;
|
||||||
|
}
|
||||||
|
</script>
|
66
templates/default/assets/bitcoin.svg
Normal file
66
templates/default/assets/bitcoin.svg
Normal file
|
@ -0,0 +1,66 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<svg
|
||||||
|
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||||
|
xmlns:cc="http://creativecommons.org/ns#"
|
||||||
|
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
width="140"
|
||||||
|
height="141.347"
|
||||||
|
version="1.1"
|
||||||
|
id="svg10"
|
||||||
|
sodipodi:docname="bitcoin.svg"
|
||||||
|
inkscape:version="1.0.2 (e86c870879, 2021-01-15)">
|
||||||
|
<metadata
|
||||||
|
id="metadata16">
|
||||||
|
<rdf:RDF>
|
||||||
|
<cc:Work
|
||||||
|
rdf:about="">
|
||||||
|
<dc:format>image/svg+xml</dc:format>
|
||||||
|
<dc:type
|
||||||
|
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||||
|
</cc:Work>
|
||||||
|
</rdf:RDF>
|
||||||
|
</metadata>
|
||||||
|
<defs
|
||||||
|
id="defs14" />
|
||||||
|
<sodipodi:namedview
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#666666"
|
||||||
|
borderopacity="1"
|
||||||
|
objecttolerance="10"
|
||||||
|
gridtolerance="10"
|
||||||
|
guidetolerance="10"
|
||||||
|
inkscape:pageopacity="0"
|
||||||
|
inkscape:pageshadow="2"
|
||||||
|
inkscape:window-width="1859"
|
||||||
|
inkscape:window-height="1017"
|
||||||
|
id="namedview12"
|
||||||
|
showgrid="false"
|
||||||
|
inkscape:zoom="2.1411258"
|
||||||
|
inkscape:cx="159.77411"
|
||||||
|
inkscape:cy="159.841"
|
||||||
|
inkscape:window-x="1341"
|
||||||
|
inkscape:window-y="27"
|
||||||
|
inkscape:window-maximized="1"
|
||||||
|
inkscape:current-layer="svg10" />
|
||||||
|
<circle
|
||||||
|
cx="70"
|
||||||
|
cy="70"
|
||||||
|
id="ellipse2"
|
||||||
|
style="fill:none;stroke:#000000;stroke-width:6.82112;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none"
|
||||||
|
r="66.589439" />
|
||||||
|
<ellipse
|
||||||
|
cx="70"
|
||||||
|
cy="70.672997"
|
||||||
|
rx="54.561001"
|
||||||
|
ry="55.102001"
|
||||||
|
id="ellipse4"
|
||||||
|
style="fill:none;stroke:#000000;stroke-width:7;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none" />
|
||||||
|
<path
|
||||||
|
d="M 77.476,42.128 H 53.623 v 25.943 h 23.853 a 12.972,12.972 0 0 0 0,-25.943 z m 0,25.943 H 53.623 v 25.943 h 23.853 a 12.972,12.972 0 0 0 0,-25.943 z M 61.463,33.477 v 8.108 m 14.011,-8.108 v 8.108 m -14.011,53.26 v 8.109 m 14.011,-8.109 v 8.109 M 46.277,42.128 h 8.108 m -8.108,51.886 h 8.108"
|
||||||
|
id="path6"
|
||||||
|
style="fill:none;stroke:#000000;stroke-width:7;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none" />
|
||||||
|
</svg>
|
After Width: | Height: | Size: 2.3 KiB |
13
templates/default/assets/chartjs/chart.js
Normal file
13
templates/default/assets/chartjs/chart.js
Normal file
File diff suppressed because one or more lines are too long
26
templates/default/assets/custom.css
Normal file
26
templates/default/assets/custom.css
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
html {
|
||||||
|
max-width: 70ch;
|
||||||
|
padding: 4em 1em;
|
||||||
|
margin: auto;
|
||||||
|
line-height: 1.75;
|
||||||
|
}
|
||||||
|
h3 {
|
||||||
|
padding: 2em 0 0.3em;
|
||||||
|
}
|
||||||
|
.dropimage, button, .button, [type=submit], .label, [data-tooltip]:after {
|
||||||
|
background: #00a440
|
||||||
|
}
|
||||||
|
|
||||||
|
.footnote {
|
||||||
|
margin-bottom: 50px;
|
||||||
|
color: rgba(0,0,0,0.7);
|
||||||
|
font-size: 0.7em;
|
||||||
|
text-align:center
|
||||||
|
}
|
||||||
|
|
||||||
|
.home-cards {
|
||||||
|
height: 100%;
|
||||||
|
padding: 10px 10px 10px 10px;
|
||||||
|
}
|
||||||
|
.home-cards h3 { padding-top: 10px }
|
||||||
|
nav { border-bottom: 1px solid #aaa}
|
BIN
templates/default/assets/favicon.ico
Normal file
BIN
templates/default/assets/favicon.ico
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.6 KiB |
51
templates/default/assets/light-bulb.svg
Normal file
51
templates/default/assets/light-bulb.svg
Normal file
|
@ -0,0 +1,51 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<svg
|
||||||
|
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||||
|
xmlns:cc="http://creativecommons.org/ns#"
|
||||||
|
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
version="1.0"
|
||||||
|
width="100"
|
||||||
|
height="100"
|
||||||
|
xml:space="preserve"
|
||||||
|
id="svg6"
|
||||||
|
sodipodi:docname="light-bulb.svg"
|
||||||
|
inkscape:version="1.0.2 (e86c870879, 2021-01-15)"><metadata
|
||||||
|
id="metadata12"><rdf:RDF><cc:Work
|
||||||
|
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
|
||||||
|
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><defs
|
||||||
|
id="defs10" /><sodipodi:namedview
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#666666"
|
||||||
|
borderopacity="1"
|
||||||
|
objecttolerance="10"
|
||||||
|
gridtolerance="10"
|
||||||
|
guidetolerance="10"
|
||||||
|
inkscape:pageopacity="0"
|
||||||
|
inkscape:pageshadow="2"
|
||||||
|
inkscape:window-width="1859"
|
||||||
|
inkscape:window-height="1017"
|
||||||
|
id="namedview8"
|
||||||
|
showgrid="false"
|
||||||
|
showguides="true"
|
||||||
|
inkscape:guide-bbox="true"
|
||||||
|
inkscape:zoom="6.052834"
|
||||||
|
inkscape:cx="70.074534"
|
||||||
|
inkscape:cy="47.818983"
|
||||||
|
inkscape:window-x="1341"
|
||||||
|
inkscape:window-y="27"
|
||||||
|
inkscape:window-maximized="1"
|
||||||
|
inkscape:current-layer="svg6" /><g
|
||||||
|
id="g839"
|
||||||
|
transform="matrix(1.2499718,0,0,1.2499687,-12.498592,-12.498437)"
|
||||||
|
style="stroke-width:0;stroke-miterlimit:4;stroke-dasharray:none"><path
|
||||||
|
d="m 50,9.999 c -14.729,0 -26.667,11.937 -26.667,26.667 0,3.609 0.729,7.066 2.041,10.208 l 7.959,19.214 v 17.246 c 0.0011,3.681625 2.985375,6.665896 6.667,6.667 h 20 c 3.68254,0.0011 6.668105,-2.98446 6.667,-6.667 V 66.095 L 74.629,46.874 C 75.976041,43.639385 76.668717,40.169891 76.667,36.666 76.667,21.936 64.733,9.999 50,9.999 Z M 61.600263,84.933676 H 38.39974 v -13.19983 l 23.200523,0.007 z M 70.069872,44.322 60.812246,66.668 H 39.187758 L 29.925949,44.306 C 28.915097,41.885903 28.396706,39.288723 28.400314,36.666 28.400314,25.637 38.972,15.066327 50,15.066327 c 11.028,0 21.599872,10.570673 21.599872,21.599673 0,2.643 -0.515,5.215 -1.53,7.656 z"
|
||||||
|
id="path2"
|
||||||
|
style="stroke-width:0;stroke-miterlimit:4;stroke-dasharray:none"
|
||||||
|
sodipodi:nodetypes="sscccccccccsccccccccccssc" /><path
|
||||||
|
d="m 44.167,24.999 -7.5,20 h 17.047 l -5,13.334 h 7.119 l 7.5,-20.001 H 46.286 l 5,-13.333 z"
|
||||||
|
id="path4"
|
||||||
|
style="stroke-width:0;stroke-miterlimit:4;stroke-dasharray:none" /></g></svg>
|
After Width: | Height: | Size: 2.6 KiB |
1
templates/default/assets/logo.svg
Normal file
1
templates/default/assets/logo.svg
Normal file
|
@ -0,0 +1 @@
|
||||||
|
<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 122.88 114.86"><defs><style>.cls-1{fill:#01a437;}</style></defs><title>leaves</title><path class="cls-1" d="M59.07,110.77C110.92,105,139.6,71.12,112.44,0c-21.29,14.9-50.39,24.6-65,44.55C57,52.94,64.89,62.23,67.08,74.37c13.19-16.08,27.63-30.72,35.23-47-7.79,39.07-20,53.84-38.78,73.81a93.64,93.64,0,0,1-4.46,9.62Zm-14.9,4C4,105-15.18,76.09,14.27,24.75c23.8,22.92,65.79,37.48,38.39,85.86a27.08,27.08,0,0,1-1.83,2.93C45.9,89.62,26.21,70.69,20.43,50.61,21.77,83.42,31.23,93,45.88,114.86c-.57,0-1.14-.06-1.71-.13Z"/></svg>
|
After Width: | Height: | Size: 603 B |
47
templates/default/assets/oven.svg
Normal file
47
templates/default/assets/oven.svg
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<svg
|
||||||
|
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||||
|
xmlns:cc="http://creativecommons.org/ns#"
|
||||||
|
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
viewBox="0 0 64 64"
|
||||||
|
style="enable-background:new 0 0 64 64"
|
||||||
|
xml:space="preserve"
|
||||||
|
version="1.1"
|
||||||
|
id="svg6"
|
||||||
|
sodipodi:docname="oven.svg"
|
||||||
|
inkscape:version="1.0.2 (e86c870879, 2021-01-15)"><metadata
|
||||||
|
id="metadata12"><rdf:RDF><cc:Work
|
||||||
|
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
|
||||||
|
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><defs
|
||||||
|
id="defs10" /><sodipodi:namedview
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#666666"
|
||||||
|
borderopacity="1"
|
||||||
|
objecttolerance="10"
|
||||||
|
gridtolerance="10"
|
||||||
|
guidetolerance="10"
|
||||||
|
inkscape:pageopacity="0"
|
||||||
|
inkscape:pageshadow="2"
|
||||||
|
inkscape:window-width="1859"
|
||||||
|
inkscape:window-height="1017"
|
||||||
|
id="namedview8"
|
||||||
|
showgrid="false"
|
||||||
|
inkscape:zoom="16"
|
||||||
|
inkscape:cx="22.304161"
|
||||||
|
inkscape:cy="16.24794"
|
||||||
|
inkscape:window-x="1085"
|
||||||
|
inkscape:window-y="27"
|
||||||
|
inkscape:window-maximized="1"
|
||||||
|
inkscape:current-layer="svg6" /><path
|
||||||
|
d="M 59.767,6.07 H 4.233 C 2.4479872,6.072205 1.001653,7.5189866 1,9.304 v 40.895 c 0,1.431 0.942,2.635 2.233,3.059 v 2.593 c 0,1.146 0.934,2.079 2.082,2.079 H 16.29 c 1.148458,-5.49e-4 2.079795,-0.930544 2.082,-2.079 V 53.432 H 45.63 v 2.419 c 0,1.146 0.932,2.079 2.079,2.079 h 10.978 c 1.147352,-0.0017 2.076898,-0.931647 2.078,-2.079 V 53.258 C 62.06,52.834 63,51.63 63,50.198 V 9.305 C 62.998347,7.5199866 61.552013,6.073205 59.767,6.071 Z M 14.873,54.3515 c 0,0.041 -0.04,0.079 -0.082,0.079 L 6.815,54.43 c -0.043,-3e-6 -0.0825,-0.0375 -0.0825,-0.0785 V 53.432 h 8.1405 v 0.9205 z m 42.394,-5e-4 c -5.39e-4,0.0434 -0.0361,0.07846 -0.0795,0.079 H 49.21 c -0.0438,3e-6 -0.07995,-0.03471 -0.0805,-0.0785 V 53.432 h 8.137 v 0.9205 z M 59.5,48.7 c 0.0042,1.262449 -0.5545,1.233 -1.2335,1.233 H 5.7325 C 5.0525,49.932 4.4995,49.38 4.4995,48.7 V 10.617 c 0,-0.68 0.553,-1.046 1.233,-1.046 h 52.534 c 0.68,0 1.233,0.365 1.233,1.046 v 38.082 z"
|
||||||
|
id="path2"
|
||||||
|
style="stroke-width:0;stroke-miterlimit:4;stroke-dasharray:none"
|
||||||
|
sodipodi:nodetypes="cccscssccccsscccsccccssscccccccccccccscssssscc" /><path
|
||||||
|
d="M 46.105,12.67 H 7.75 c -0.5522847,0 -1,0.447715 -1,1 v 32.18 c 0,0.552285 0.4477153,1 1,1 h 38.356 c 0.552285,0 1,-0.447715 1,-1 V 13.67 c 0,-0.552285 -0.447715,-1 -1,-1 z m -2.5,2 -5e-4,12.592 H 10.25 V 16.17 H 43.6055 Z M 10.25,43.35 V 30.762 H 43.6055 V 43.35 Z M 51.39,18.044 h 4.789 c 1.333333,0 1.333333,-3.5 0,-3.5 H 51.39 c -1.333333,0 -1.333333,3.5 0,3.5 z m 0,6.754 h 4.789 c 1.333333,0 1.333333,-3.5 0,-3.5 H 51.39 c -1.333333,0 -1.333333,3.5 0,3.5 z m 2.535,11.794 c -2.202,0 -3.993,1.791 -3.993,3.994 0,2.203 1.79,3.993 3.993,3.993 2.203,0 3.994,-1.791 3.994,-3.994 0,-2.203 -1.792,-3.993 -3.994,-3.993 z m 0,5.987 c -1.099,0 -1.993,-0.894 -1.993,-1.994 0,-1.1 0.894,-1.993 1.993,-1.993 1.1,0 1.994,0.894 1.994,1.993 0,1.099 -0.895,1.994 -1.994,1.994 z M 51.39,31.81 h 4.789 c 1.333333,0 1.333333,-3.5 0,-3.5 H 51.39 c -1.333333,0 -1.333333,3.5 0,3.5 z"
|
||||||
|
id="path4"
|
||||||
|
style="stroke-width:0;stroke-miterlimit:4;stroke-dasharray:none"
|
||||||
|
sodipodi:nodetypes="cssssssssccccccccccccsssssssssssssssssssssssss" /></svg>
|
After Width: | Height: | Size: 3.5 KiB |
1
templates/default/assets/picnic/picnic.min.css
vendored
Normal file
1
templates/default/assets/picnic/picnic.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
137
templates/default/assets/washing.svg
Normal file
137
templates/default/assets/washing.svg
Normal file
|
@ -0,0 +1,137 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||||
|
<svg
|
||||||
|
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||||
|
xmlns:cc="http://creativecommons.org/ns#"
|
||||||
|
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||||
|
xmlns:svg="http://www.w3.org/2000/svg"
|
||||||
|
xmlns="http://www.w3.org/2000/svg"
|
||||||
|
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||||
|
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||||
|
version="1.1"
|
||||||
|
id="Layer_1"
|
||||||
|
x="0"
|
||||||
|
y="0"
|
||||||
|
viewBox="0 0 64 64"
|
||||||
|
style="enable-background:new 0 0 64 64"
|
||||||
|
xml:space="preserve"
|
||||||
|
sodipodi:docname="washing.svg"
|
||||||
|
inkscape:version="1.0.2 (e86c870879, 2021-01-15)"><metadata
|
||||||
|
id="metadata12"><rdf:RDF><cc:Work
|
||||||
|
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
|
||||||
|
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><defs
|
||||||
|
id="defs10" /><sodipodi:namedview
|
||||||
|
pagecolor="#ffffff"
|
||||||
|
bordercolor="#666666"
|
||||||
|
borderopacity="1"
|
||||||
|
objecttolerance="10"
|
||||||
|
gridtolerance="10"
|
||||||
|
guidetolerance="10"
|
||||||
|
inkscape:pageopacity="0"
|
||||||
|
inkscape:pageshadow="2"
|
||||||
|
inkscape:window-width="1859"
|
||||||
|
inkscape:window-height="1017"
|
||||||
|
id="namedview8"
|
||||||
|
showgrid="false"
|
||||||
|
showguides="true"
|
||||||
|
inkscape:guide-bbox="true"
|
||||||
|
inkscape:zoom="9.4575532"
|
||||||
|
inkscape:cx="40.40291"
|
||||||
|
inkscape:cy="11.162574"
|
||||||
|
inkscape:window-x="1341"
|
||||||
|
inkscape:window-y="27"
|
||||||
|
inkscape:window-maximized="1"
|
||||||
|
inkscape:current-layer="Layer_1"><sodipodi:guide
|
||||||
|
position="6,64"
|
||||||
|
orientation="0,-1"
|
||||||
|
id="guide843" /><sodipodi:guide
|
||||||
|
position="6,0"
|
||||||
|
orientation="0,-1"
|
||||||
|
id="guide845" /><sodipodi:guide
|
||||||
|
position="10,50"
|
||||||
|
orientation="0,-1"
|
||||||
|
id="guide847" /><sodipodi:guide
|
||||||
|
position="10,46"
|
||||||
|
orientation="0,-1"
|
||||||
|
id="guide849" /><sodipodi:guide
|
||||||
|
position="10,4"
|
||||||
|
orientation="0,-1"
|
||||||
|
id="guide851" /><sodipodi:guide
|
||||||
|
position="10,60"
|
||||||
|
orientation="0,-1"
|
||||||
|
id="guide853" /><sodipodi:guide
|
||||||
|
position="6,64"
|
||||||
|
orientation="1,0"
|
||||||
|
id="guide855" /><sodipodi:guide
|
||||||
|
position="10,60"
|
||||||
|
orientation="1,0"
|
||||||
|
id="guide857" /><sodipodi:guide
|
||||||
|
position="54,60"
|
||||||
|
orientation="1,0"
|
||||||
|
id="guide859" /><sodipodi:guide
|
||||||
|
position="58,64"
|
||||||
|
orientation="1,0"
|
||||||
|
id="guide861" /><sodipodi:guide
|
||||||
|
position="8,64"
|
||||||
|
orientation="-1,0"
|
||||||
|
id="guide867"
|
||||||
|
inkscape:label=""
|
||||||
|
inkscape:locked="false"
|
||||||
|
inkscape:color="rgb(0,0,255)" /><sodipodi:guide
|
||||||
|
position="56,64"
|
||||||
|
orientation="-1,0"
|
||||||
|
id="guide869"
|
||||||
|
inkscape:label=""
|
||||||
|
inkscape:locked="false"
|
||||||
|
inkscape:color="rgb(0,0,255)" /><sodipodi:guide
|
||||||
|
position="6,62"
|
||||||
|
orientation="0,1"
|
||||||
|
id="guide871"
|
||||||
|
inkscape:label=""
|
||||||
|
inkscape:locked="false"
|
||||||
|
inkscape:color="rgb(0,0,255)" /><sodipodi:guide
|
||||||
|
position="58,2"
|
||||||
|
orientation="0,1"
|
||||||
|
id="guide875"
|
||||||
|
inkscape:label=""
|
||||||
|
inkscape:locked="false"
|
||||||
|
inkscape:color="rgb(0,0,255)" /><sodipodi:guide
|
||||||
|
position="54,57"
|
||||||
|
orientation="0,1"
|
||||||
|
id="guide886"
|
||||||
|
inkscape:label=""
|
||||||
|
inkscape:locked="false"
|
||||||
|
inkscape:color="rgb(0,0,255)" /><sodipodi:guide
|
||||||
|
position="61.943925,53"
|
||||||
|
orientation="0,1"
|
||||||
|
id="guide888"
|
||||||
|
inkscape:label=""
|
||||||
|
inkscape:locked="false"
|
||||||
|
inkscape:color="rgb(0,0,255)" /><sodipodi:guide
|
||||||
|
position="50,60"
|
||||||
|
orientation="-1,0"
|
||||||
|
id="guide890"
|
||||||
|
inkscape:label=""
|
||||||
|
inkscape:locked="false"
|
||||||
|
inkscape:color="rgb(0,0,255)" /><sodipodi:guide
|
||||||
|
position="40,60"
|
||||||
|
orientation="-1,0"
|
||||||
|
id="guide894"
|
||||||
|
inkscape:label=""
|
||||||
|
inkscape:locked="false"
|
||||||
|
inkscape:color="rgb(0,0,255)" /></sodipodi:namedview><style
|
||||||
|
id="style2">.st0{fill:#231f20}</style><path
|
||||||
|
id="XMLID_579_"
|
||||||
|
class="st0"
|
||||||
|
d="M 31.94,21 C 22.05,21 14,29.05 14,38.94 c 0,9.89 8.05,17.94 17.94,17.94 9.89,0 17.94,-8.05 17.94,-17.94 C 49.87,29.05 41.83,21 31.94,21 Z m 0,31.87 C 24.25,52.87 18,46.62 18,38.94 18,31.26 24.25,25 31.94,25 c 7.69,0 13.94,6.25 13.94,13.94 0,7.69 -6.26,13.93 -13.94,13.93 z"
|
||||||
|
style="fill:#000000" /><path
|
||||||
|
id="XMLID_575_"
|
||||||
|
class="st0"
|
||||||
|
d="m 6,4 v 56 c 0,2 2,4 4,4 h 44 c 2,0 4,-2 4,-3.998983 V 3.9642939 C 58,2 56,0 54.031875,0 H 10 C 8,0 6,2 6,4 Z M 54,4 V 14 H 10 V 4 Z M 10,60 V 18 h 44 v 42 z"
|
||||||
|
sodipodi:nodetypes="ccccccccccccccccccc"
|
||||||
|
style="fill:#000000;fill-opacity:1;stroke:none;stroke-opacity:1" /><rect
|
||||||
|
style="fill:#000000;fill-opacity:1;stroke:none;stroke-width:7;stroke-opacity:1"
|
||||||
|
id="rect896"
|
||||||
|
width="10"
|
||||||
|
height="4"
|
||||||
|
x="40"
|
||||||
|
y="7" /></svg>
|
After Width: | Height: | Size: 4.7 KiB |
36
templates/default/base.html
Normal file
36
templates/default/base.html
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<title>EcoDash</title>
|
||||||
|
<link rel="stylesheet" href="assets/picnic/picnic.min.css">
|
||||||
|
<link rel="stylesheet" href="assets/custom.css">
|
||||||
|
<link rel="icon" type="image/x-icon" href="assets/favicon.ico">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<nav>
|
||||||
|
<a href="./" class="brand">
|
||||||
|
<img class="logo" src="assets/logo.svg" />
|
||||||
|
<span>{{.Defaults.DashboardName}}</span>
|
||||||
|
</a>
|
||||||
|
<input id="bmenub" type="checkbox" class="show">
|
||||||
|
<label for="bmenub" class="burger button">Menu</label>
|
||||||
|
<div class="menu">
|
||||||
|
{{range .Defaults.HeaderLinks}}
|
||||||
|
<a href="{{.Destination}}" class="{{if not .Primary}}pseudo {{end}}button" {{if .NewTab}}target="_blank" rel="noopener noreferrer"{{end}}>{{.Label}}</a>
|
||||||
|
{{end}}
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
{{embed}}
|
||||||
|
|
||||||
|
<hr style="margin-top: 30px">
|
||||||
|
<p style="margin: 0; padding: 17px 0 17px 0; text-align:center">
|
||||||
|
{{range .Defaults.FooterLinks}}
|
||||||
|
<a href="{{.Destination}}" {{if .NewTab}}target="_blank" rel="noopener noreferrer"{{end}}>{{.Label}}</a> |
|
||||||
|
{{end}}
|
||||||
|
<a href="./accuracy-notice">Disclaimer</a> | <a href="https://gitea.massivebox.net/massivebox/ecodash" target="_blank" rel="noopener noreferrer">EcoDash</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
105
templates/default/index.html
Normal file
105
templates/default/index.html
Normal file
|
@ -0,0 +1,105 @@
|
||||||
|
<script src="assets/chartjs/chart.js"></script>
|
||||||
|
|
||||||
|
<h1>Green report</h1>
|
||||||
|
|
||||||
|
<canvas id="report"></canvas>
|
||||||
|
<p class="footnote">
|
||||||
|
This server's energy statistics for the last eight days (current day included)
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<div class="flex two">
|
||||||
|
<div>
|
||||||
|
<div class="home-cards card">
|
||||||
|
<div>
|
||||||
|
<h3>Energy usage per day</h3>
|
||||||
|
<svg width="100%" height="50px" viewBox="0 0 80 15">
|
||||||
|
<text x="0" y="15">{{.PerDayUsage}} kWh</text>
|
||||||
|
</svg>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div class="home-cards card">
|
||||||
|
<div>
|
||||||
|
<h3>Green energy %</h3>
|
||||||
|
<svg width="100%" height="50px" viewBox="0 0 80 15">
|
||||||
|
<text x="0" y="15">{{.GreenEnergyPercent}} %</text>
|
||||||
|
</svg>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<article class="card">
|
||||||
|
<header>
|
||||||
|
<h3>This server consumes in a day as much as...</h3>
|
||||||
|
</header>
|
||||||
|
<footer>
|
||||||
|
<div class="flex two four-600">
|
||||||
|
<div>
|
||||||
|
<img src="assets/light-bulb.svg" alt="Lightbulb" style="width: 100%">
|
||||||
|
<p><b>{{divide .PerDayUsage 0.072}} desk lights</b> running for a day</p>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<img src="assets/washing.svg" alt="Air Conditioner" style="width: 100%">
|
||||||
|
<p><b>{{divide .PerDayUsage 0.66}} washing machines</b> completing a cycle</p>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<img src="assets/oven.svg" alt="Oven" style="width: 100%">
|
||||||
|
<p><b>{{divide .PerDayUsage 1.2}} electric ovens</b> baking a cake</p>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<img src="assets/bitcoin.svg" alt="Bitcoin" style="width: 100%">
|
||||||
|
<p><b>{{divide .PerDayUsage 1300}} Bitcoin transactions</b></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
|
||||||
|
<p class="footnote">
|
||||||
|
Calculated on the latest seven days (current day excluded).
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
|
||||||
|
const data = {
|
||||||
|
labels: {{.Labels}},
|
||||||
|
datasets: [
|
||||||
|
{
|
||||||
|
label: 'Green energy usage',
|
||||||
|
backgroundColor: '#00a440',
|
||||||
|
borderColor: '#00a440',
|
||||||
|
data: {{.GreenEnergyPercents}},
|
||||||
|
}, {
|
||||||
|
label: 'Total energy usage',
|
||||||
|
backgroundColor: 'rgba(0,116,217,0.8)',
|
||||||
|
borderColor: '#0074d9',
|
||||||
|
data: {{.EnergyConsumptions}},
|
||||||
|
}
|
||||||
|
]
|
||||||
|
};
|
||||||
|
|
||||||
|
const myChart = new Chart(
|
||||||
|
document.getElementById('report'),
|
||||||
|
{
|
||||||
|
data: data,
|
||||||
|
type: 'bar',
|
||||||
|
options: {
|
||||||
|
scales: {
|
||||||
|
x: {
|
||||||
|
stacked: true
|
||||||
|
},
|
||||||
|
y: {
|
||||||
|
position: 'left',
|
||||||
|
min: 0,
|
||||||
|
title: {
|
||||||
|
display: true,
|
||||||
|
text: 'Energy usage (kWh)'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
</script>
|
19
templates/default/login.html
Normal file
19
templates/default/login.html
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
<h1>Login</h1>
|
||||||
|
<p>Insert your credentials to access the Admin Panel.</p>
|
||||||
|
|
||||||
|
{{if .Failed}}
|
||||||
|
<article class="card" style="background-color: #ff5050; color: white">
|
||||||
|
<header>
|
||||||
|
<h3>Error!</h3>
|
||||||
|
</header>
|
||||||
|
<footer>
|
||||||
|
<p>There was a problem with the login. Check your credentials and try again.</p>
|
||||||
|
</footer>
|
||||||
|
</article>
|
||||||
|
{{end}}
|
||||||
|
|
||||||
|
<form action="./admin" method="POST">
|
||||||
|
<label>Username <input type="text" name="username" required></label>
|
||||||
|
<label>Password <input type="password" name="password" required></label>
|
||||||
|
<input type="submit" placeholder="Submit">
|
||||||
|
</form>
|
6
templates/default/restart.html
Normal file
6
templates/default/restart.html
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
<h1>Restarting...</h1>
|
||||||
|
<p>
|
||||||
|
You should be able to continue using EcoDash soon by clicking <a href="/">here</a>.<br>
|
||||||
|
If you get an error like "Address Unreachable", make sure you've allowed your container to restart automatically.<br>
|
||||||
|
Check the error logs if the error persists.
|
||||||
|
</p>
|
Loading…
Reference in a new issue