mirror of
https://github.com/bvanroll/_dotfiles.git
synced 2025-08-30 12:32:41 +00:00
initial commit
This commit is contained in:
339
.config/i3blocks/purpleair/LICENSE
Normal file
339
.config/i3blocks/purpleair/LICENSE
Normal file
@@ -0,0 +1,339 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) 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
|
||||
this service 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 make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. 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.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
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
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the 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 a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE 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.
|
||||
|
||||
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
|
||||
convey 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 2 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, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision 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, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This 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.
|
76
.config/i3blocks/purpleair/README.md
Normal file
76
.config/i3blocks/purpleair/README.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# purpleair
|
||||
|
||||
Get air quality readings from [PurpleAir](http://purpleair.com) sensors.
|
||||
|
||||

|
||||
|
||||
# Requirements
|
||||
|
||||
Dependencies: perl, curl, jq
|
||||
|
||||
# Configuration
|
||||
|
||||
A purpleair config block looks like this:
|
||||
|
||||
```INI
|
||||
[purpleair]
|
||||
label=
|
||||
command=$SCRIPT_DIR/purpleair
|
||||
interval=60
|
||||
SENSOR_ID=78305
|
||||
#TYPE=US_AQI
|
||||
#COLORS=#85df56,#fbcf4b,#f28c33,#dd4d3c,#cf79e0,#9b2f6a
|
||||
#NO_COLOR=true
|
||||
```
|
||||
|
||||
## Finding a sensor ID
|
||||
|
||||
If you do not own a PurpleAir sensor, there may be one near you that you can query. Here's how to find a sensor ID:
|
||||
|
||||
1. Navigate to http://purpleair.com/map and find a reading near you.
|
||||
1. Click on the reading to bring up a details card. (Note, sensors with a block border are indoors. You'll likely want a plain circle).
|
||||
1. At the bottom of the card, hover over "Get This Widget", and click the "JSON" link.
|
||||
1. The sensor ID is the value of the URL's "show" query parameter.
|
||||
|
||||
If you own a PurpleAir sensor, use its ID. If your sensor is configured to be private, see the [PurpleAir FAQ](https://www2.purpleair.com/community/faq#hc-access-the-json) for extra access requirements. If your sensor is public and you do not know its ID, see the instructions above to find it.
|
||||
|
||||
## Configuration Parameters
|
||||
|
||||
There is one required parameter, along with some optional ones:
|
||||
|
||||
Parameter | Description
|
||||
--------- | -----------
|
||||
SENSOR_ID | Required: The PurpleAir sensor to query
|
||||
TYPE | Optional: The air quality computation to perform. Default: US_AQI
|
||||
COLORS | Optional: Comma-separated list of color hex values to use in place of the default colors
|
||||
NO_COLOR | Optional: Any non-empty value causes color to be suppressed
|
||||
|
||||
### TYPE
|
||||
|
||||
The valid values for `TYPE` are:
|
||||
|
||||
Type | Description
|
||||
------- | -----------
|
||||
US_AQI | [United States Air Quality Index](https://www.airnow.gov/aqi/aqi-basics/)
|
||||
EU_AQI | [European Air Quality Index](https://airindex.eea.europa.eu/)
|
||||
CA_AQHI | [Canada Air Quality Health Index](https://www.canada.ca/en/environment-climate-change/services/air-quality-health-index/about.html)
|
||||
IMECA | [Índice MEtropolitano de la Calidad del Aire](https://www.gob.mx/comisionambiental/es/articulos/imeca-indice-metropolitano-de-la-calidad-del-aire)
|
||||
IAS | [Índice de Aire y Salud](http://www.aire.cdmx.gob.mx/default.php?opc=%27ZaBhnmI=&dc=%27Zw==)
|
||||
|
||||
### COLORS
|
||||
|
||||
The `COLORS` parameter should be specified without spaces or quotes.
|
||||
|
||||
Good: `COLORS=#ffffff,#aaaaaa,#888888`
|
||||
|
||||
Bad: `COLORS="#ffffff,#aaaaaa,#888888"`
|
||||
|
||||
Bad: `COLORS=#ffffff, #aaaaaa, #888888`
|
||||
|
||||
If fewer colors are specified than the `TYPE` uses by default, a warning will be printed to `stderr`. Also, any color index higher than the maximum index given will be reduced to the maximum index.
|
||||
|
||||
### NO_COLOR
|
||||
|
||||
The `NO_COLOR` parameter suppresses colors, so the output will use the default output color of the bar.
|
||||
|
||||
Any non-empty value will trigger its effect, but by convention it should be specified `NO_COLOR=true`.
|
7
.config/i3blocks/purpleair/i3blocks.conf
Normal file
7
.config/i3blocks/purpleair/i3blocks.conf
Normal file
@@ -0,0 +1,7 @@
|
||||
[purpleair]
|
||||
label=
|
||||
command=$SCRIPT_DIR/purpleair
|
||||
interval=60
|
||||
SENSOR_ID=78305
|
||||
TYPE=US_AQI
|
||||
COLORS=#85df56,#fbcf4b,#f28c33,#dd4d3c,#cf79e0,#9b2f6a
|
249
.config/i3blocks/purpleair/purpleair
Executable file
249
.config/i3blocks/purpleair/purpleair
Executable file
@@ -0,0 +1,249 @@
|
||||
#!/bin/perl
|
||||
# For temperature: subtract 8 from the F value for the actual temperature
|
||||
|
||||
# Get PurpleAir sensor ID
|
||||
if ($ENV{'SENSOR_ID'} == "") {
|
||||
print STDERR "Missing required environment variable 'SENSOR_ID'.\n";
|
||||
exit 1;
|
||||
}
|
||||
$sensor_id = $ENV{'SENSOR_ID'};
|
||||
|
||||
# Get measurement type. Default: US_AQI
|
||||
@valid_types = ("US_AQI", "EU_AQI", "CA_AQHI", "IMECA", "IAS");
|
||||
$type = 'US_AQI';
|
||||
if (grep(/^$ENV{'TYPE'}$/, @valid_types)) {
|
||||
$type = $ENV{'TYPE'};
|
||||
} elsif ($ENV{'TYPE'}) {
|
||||
print STDERR "Unrecognized TYPE: $ENV{'TYPE'}. Valid values are: [@valid_types]";
|
||||
exit 1;
|
||||
}
|
||||
|
||||
# Read pm2.5 10-minute average from the PurpleAir sensor
|
||||
$pm2_5 = `curl "http://purpleair.com/json?show=$sensor_id" 2>/dev/null \\
|
||||
| jq -r '.results | map(select(has("Stats")) | .Stats | fromjson | .v1) | add / length'`;
|
||||
|
||||
###################
|
||||
# IMPLEMENTATIONS #
|
||||
###################
|
||||
|
||||
sub UsAqi {
|
||||
# See https://forum.airnowtech.org/t/the-aqi-equation/169
|
||||
#
|
||||
# PM2.5 | ConcLo | ConcHi | AQILo | AQIHi
|
||||
# Good | 0.0 | 12.0 | 0 | 50
|
||||
# Moderate | 12.1 | 35.4 | 51 | 100
|
||||
# Unhealthy Sensitive | 35.5 | 55.4 | 101 | 150
|
||||
# Unhealthy | 55.5 | 150.4 | 151 | 200
|
||||
# Very Unhealthy | 150.5 | 250.4 | 201 | 300
|
||||
# Hazardous | 250.5 | 500.4 | 301 | 500
|
||||
#
|
||||
# |------------Multiplier-----------| Threshold Addition
|
||||
# (AQIHi - AQILo) / (ConcHi - ConcLo) * (ConcNow - ConcLo) + AQILo
|
||||
|
||||
@colors = ("#00e400", "#ffff00", "#ff7e00", "#ff0000", "#8f3f97", "#7e0023");
|
||||
$pm2_5 = $_[0];
|
||||
|
||||
# Table of values: Threshold, Multiplier, Addition
|
||||
@t = (
|
||||
[0.0, 4.1667, 0.0],
|
||||
[12.1, 2.1030, 51],
|
||||
[35.5, 2.4623, 101],
|
||||
[55.5, 0.5163, 151],
|
||||
[150.5, 0.9910, 201],
|
||||
[250.5, 0.7963, 301]
|
||||
);
|
||||
|
||||
# Find relevant row for computation based on pm2.5 threshold
|
||||
for ($i = 5; $i >= 0; $i--) {
|
||||
if ($pm2_5 >= $t[$i][0]) {
|
||||
$r = $i;
|
||||
last;
|
||||
}
|
||||
}
|
||||
|
||||
# Compute AQI from raw pm2.5 concentration
|
||||
$aqi = $t[$r][1] * ($pm2_5 - $t[$r][0]) + $t[$r][2];
|
||||
|
||||
return (
|
||||
'val' => sprintf("%.0f", $aqi),
|
||||
'colors' => [@colors],
|
||||
'color_idx' => $r
|
||||
);
|
||||
}
|
||||
|
||||
sub EuAqi {
|
||||
# See https://airindex.eea.europa.eu/Map/AQI/Viewer/
|
||||
# European Air Quality Index uses the pm2.5 concentration directly.
|
||||
|
||||
@colors = ("#50f0e6", "#50ccaa", "#f0e641", "#ff5050", "#960032", "#7d2181");
|
||||
$pm2_5 = $_[0];
|
||||
|
||||
# Thresholds for color indices
|
||||
@t = (0.0, 10.0, 20.0, 25.0, 50.0, 75.0);
|
||||
|
||||
# Find relevant row for computation based on pm2.5 threshold
|
||||
for ($i = 5; $i >= 0; $i--) {
|
||||
if ($pm2_5 >= $t[$i]) {
|
||||
$r = $i;
|
||||
last;
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
'val' => sprintf("%.0f", $pm2_5),
|
||||
'colors' => [@colors],
|
||||
'color_idx' => $r
|
||||
);
|
||||
}
|
||||
|
||||
sub CaAqhi {
|
||||
# See https://en.wikipedia.org/wiki/Air_Quality_Health_Index_(Canada)#Calculation
|
||||
# Note: AQHI should also incorporate O3 and NO2, but PurpleAir only has PM2.5
|
||||
# The pm2.5 calculation is used alone and multiplied by 3.
|
||||
# 1-3: Low
|
||||
# 4-6: Moderate
|
||||
# 7-10: High
|
||||
# 11+: Very High
|
||||
|
||||
@colors = (
|
||||
"#00ccff", "#0099cc", "#006699",
|
||||
"#ffff00", "#ffcc00", "#ff9933",
|
||||
"#ff6666", "#ff0000", "#cc0000",
|
||||
"#990000", "#660000");
|
||||
$pm2_5 = $_[0];
|
||||
|
||||
$aqhi = 3 * 1000 / 10.4 * ((exp(0.000487 * $pm2_5) - 1));
|
||||
|
||||
return (
|
||||
'val' => sprintf("%.0f", $aqhi >= 1 ? $aqhi : 1),
|
||||
'colors' => [@colors],
|
||||
'color_idx' => $r
|
||||
);
|
||||
}
|
||||
|
||||
sub Imeca {
|
||||
# See http://rama.edomex.gob.mx/imeca
|
||||
#
|
||||
# PM2.5 | Threshold | Multiplier | Addition
|
||||
# Buena | 0.0 | 4.17 | 0
|
||||
# Regular | 12.1 | 1.49 | 51
|
||||
# Mala | 45.1 | 0.94 | 101
|
||||
# Muy Mala | 97.5 | 0.93 | 151
|
||||
# Extremadamente Mala | 150.5 | 0.99 | 201
|
||||
# Extremadamente Mala | 250.5 | 0.99 | 301
|
||||
# Extremadamente Mala | 350.5 | 0.66 | 401
|
||||
#
|
||||
# Multiplier * (pm2.5 - Threshold) + Addition
|
||||
|
||||
@colors = ("#00e400", "#ffff00", "#ff7e00", "#ff0000", "#99004c", "#99004c", "#99004c");
|
||||
$pm2_5 = $_[0];
|
||||
|
||||
# Table of values: Threshold, Multiplier, Addition
|
||||
@t = (
|
||||
[0.0, 4.17, 0.0],
|
||||
[12.1, 1.49, 51.0],
|
||||
[45.1, 0.94, 101.0],
|
||||
[97.5, 0.93, 151.0],
|
||||
[150.5, 0.99, 201.0],
|
||||
[250.5, 0.99, 301.0],
|
||||
[350.5, 0.66, 401.0]
|
||||
);
|
||||
|
||||
# Find relevant row for computation based on pm2.5 threshold
|
||||
for ($i = 6; $i >= 0; $i--) {
|
||||
if ($pm2_5 >= $t[$i][0]) {
|
||||
$r = $i;
|
||||
last;
|
||||
}
|
||||
}
|
||||
|
||||
# Compute AQI from raw pm2.5 concentration
|
||||
$aqi = $t[$r][1] * ($pm2_5 - $t[$r][0]) + $t[$r][2];
|
||||
|
||||
return (
|
||||
'val' => sprintf("%.0f", $aqi),
|
||||
'colors' => [@colors],
|
||||
'color_idx' => $r
|
||||
);
|
||||
}
|
||||
|
||||
sub Ias {
|
||||
# See https://www.dof.gob.mx/nota_detalle_popup.php?codigo=5576807
|
||||
# Índice de aire y salud uses the pm2.5 concentration directly.
|
||||
|
||||
@colors = ("#00e400", "#ffff00", "#ff7e00", "#ff0000", "#99004c");
|
||||
$pm2_5 = $_[0];
|
||||
|
||||
# Thresholds for color indices
|
||||
@t = (0.0, 26.0, 46.0, 80.0, 148.0);
|
||||
|
||||
# Find relevant row for computation based on pm2.5 threshold
|
||||
for ($i = 4; $i >= 0; $i--) {
|
||||
if ($pm2_5 >= $t[$i]) {
|
||||
$r = $i;
|
||||
last;
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
'val' => sprintf("%.0f", $pm2_5),
|
||||
'colors' => [@colors],
|
||||
'color_idx' => $r
|
||||
);
|
||||
}
|
||||
|
||||
##################
|
||||
# OUTPUT RESULTS #
|
||||
##################
|
||||
|
||||
# Compute requested value
|
||||
# Expected return value is a hash of the form:
|
||||
# (
|
||||
# 'val' => <numeric measurement value>,
|
||||
# 'colors' => [<color hex codes>],
|
||||
# 'color_idx' => <0-based index of color array>,
|
||||
# )
|
||||
if ($type eq "US_AQI") {
|
||||
%result = UsAqi($pm2_5);
|
||||
} elsif ($type eq "EU_AQI") {
|
||||
%result = EuAqi($pm2_5);
|
||||
} elsif ($type eq "CA_AQHI") {
|
||||
%result = CaAqhi($pm2_5);
|
||||
} elsif ($type eq "IMECA") {
|
||||
%result = Imeca($pm2_5);
|
||||
} elsif ($type eq "IAS") {
|
||||
%result = Ias($pm2_5);
|
||||
} else {
|
||||
# It should not be possible to reach here.
|
||||
%result = (
|
||||
'val' => 'ERR',
|
||||
'colors' => ("#ff0000"),
|
||||
'color_idx' => 0,
|
||||
'num_colors' => 1
|
||||
);
|
||||
}
|
||||
|
||||
# Get color overrides, if any.
|
||||
if ($ENV{'COLORS'}) {
|
||||
@colors = split(',', $ENV{'COLORS'});
|
||||
if (scalar(@colors) < scalar(@{ $result{'colors'} })) {
|
||||
print STDERR "Warning: number of color overrides is fewer than the number".
|
||||
" of buckets in type $type\n";
|
||||
}
|
||||
} else {
|
||||
@colors = @{ $result{'colors'} };
|
||||
}
|
||||
|
||||
# Adjust color index if greater than colors length
|
||||
$color_idx = $result{'color_idx'};
|
||||
if ($color_idx >= scalar(@colors)) {
|
||||
$color_idx = scalar(@colors) - 1;
|
||||
}
|
||||
|
||||
# Full text, short text, color
|
||||
print "$result{'val'}\n";
|
||||
print "$result{'val'}\n";
|
||||
|
||||
if (!$ENV{'NO_COLOR'}) {
|
||||
print "$colors[$color_idx]\n";
|
||||
}
|
BIN
.config/i3blocks/purpleair/purpleair.png
Normal file
BIN
.config/i3blocks/purpleair/purpleair.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 887 B |
Reference in New Issue
Block a user