Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

41 fix inky message override #64

Open
wants to merge 29 commits into
base: weather
Choose a base branch
from
Open
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
bf5e112
Merge pull request #21 from balenalabs/weather
catt-tung Oct 13, 2020
fd46bad
v1.0.0
balena-ci Oct 13, 2020
531062e
Fix the weather icon symbol lookup
gelbal Oct 14, 2020
f19f04c
Merge pull request #28 from balenalabs/fix-weather-icon-bug
Oct 14, 2020
f97e7ba
v1.0.1
balena-ci Oct 14, 2020
9557fd4
Add support for latest Inky(X)HAT boards
chrisys Oct 19, 2020
bf8c6c6
Merge pull request #29 from balenalabs/bump-package-versions
Oct 20, 2020
e82a087
v1.1.0
balena-ci Oct 20, 2020
46cacb6
Create LICENSE
catt-tung Nov 27, 2020
d069009
Add additional fonts
catt-tung Dec 7, 2020
2cd2e89
Merge pull request #35 from balenalabs/catt-tung-patch-1
Dec 7, 2020
0290f8b
v1.1.1
balena-ci Dec 7, 2020
669b43a
Use wifi-connect block
rahul-thakoor Dec 8, 2020
0072776
Merge pull request #36 from balenalabs/add-wifi-connect-block
catt-tung Dec 8, 2020
01defd9
v1.2.0
balena-ci Dec 8, 2020
6e2d2b6
Add balena.yml and logo (hub)
chrisys Dec 17, 2020
b4a1b72
Merge pull request #37 from balenalabs/add-balena-yml
Dec 17, 2020
06467b1
v1.2.1
balena-ci Dec 17, 2020
a8fca37
Update balena.yml
chrisys Dec 17, 2020
3f7506a
Alternate between quote and weather modes
gelbal Dec 18, 2020
fe62988
Merge pull request #38 from balenalabs/fix-alternate-mode
Dec 18, 2020
9940b97
Add user-agent to weather API calls
gelbal Dec 18, 2020
ef6a546
v1.3.0
balena-ci Dec 18, 2020
53c3cae
Merge pull request #39 from balenalabs/fix-weather-info
Dec 18, 2020
b100d49
v1.3.1
balena-ci Dec 18, 2020
0abfc7b
Enable supervisor API access
gelbal Dec 18, 2020
d2dd969
Merge pull request #40 from balenalabs/fix-multicontainer-api
Dec 18, 2020
3a8de74
v1.3.2
balena-ci Dec 18, 2020
0eddc49
Don't overwrite custom message
gelbal Dec 28, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,51 @@ All notable changes to this project will be documented in this file
automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
This project adheres to [Semantic Versioning](http://semver.org/).

# v1.3.2
## (2020-12-18)

* Enable supervisor API access [gelbal]

# v1.3.1
## (2020-12-18)

* Add user-agent to weather API calls As the API has this restriction [gelbal]

# v1.3.0
## (2020-12-18)

* Alternate between quote and weather modes Simplify the alternate logic Use device tags instead env vars [gelbal]

# v1.2.1
## (2020-12-17)

* Add balena.yml and logo (hub) [Chris Crocker-White]

# v1.2.0
## (2020-12-08)

* Use wifi-connect block [Rahul Thakoor]

# v1.1.1
## (2020-12-07)

* Add additional fonts [Catt]

# v1.1.0
## (2020-10-20)

* Add support for latest Inky(X)HAT boards [Chris Crocker-White]

# v1.0.1
## (2020-10-14)

* Fix the weather icon symbol lookup [gelbal]

# v1.0.0
## (2020-10-06)

* Display weather forecast with icons [gelbal]

# v0.4.2
## (2020-10-01)

201 changes: 201 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -8,12 +8,12 @@

![](https://raw.githubusercontent.com/balenalabs-incubator/inkyshot/master/assets/hardware-photo.jpg)

* Raspberry Pi (tested with Zero and 3B so far)
* [Pimoroni InkyPHAT display](https://shop.pimoroni.com/products/inky-phat?variant=12549254938707)
* 8GB SD Card (Sandisk Extreme Pro recommended)
* Power supply
* **Optional:** 3D printed case with [micro USB sockets](https://www.aliexpress.com/item/4000484202812.html)
* **Optional:** [Waveshare 2.13" e-paper display V2](https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT) (**Note:** the case designs will need modification to fit this display. Set the `WAVESHARE` environment variable to `1` to enable support)
- Raspberry Pi (tested with Zero and 3B so far)
- [Pimoroni InkyPHAT display](https://shop.pimoroni.com/products/inky-phat?variant=12549254938707)
- 8GB SD Card (Sandisk Extreme Pro recommended)
- Power supply
- **Optional:** 3D printed case with [micro USB sockets](https://www.aliexpress.com/item/4000484202812.html)
- **Optional:** [Waveshare 2.13" e-paper display V2](https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT) (**Note:** the case designs will need modification to fit this display. Set the `WAVESHARE` environment variable to `1` to enable support)

## Setup & Installation

@@ -60,7 +60,8 @@ When figuring out what size font to use, Inkyshot (invisibly) fills the screen w
If Inkyshot is living in a different house where things aren't necessarily always the same way up, use the `ROTATE` environment variable to rotate the output by 180 degrees.

### Weather
To enable the weather display, set the environment variable `NEXT_DISPLAY` to `weather`.

To enable the weather display, set the environment variable `MODE` to `weather`.

Next, use either `LATLONG` (e.g. 39.9199,32.8543) or `WEATHER_LOCATION` (e.g. Ankara, Turkey) environment variables to define the location for weather information. Entering only an empty `WEATHER_LOCATION` is also sufficient and in this case Inkyshot will lookup the latitude and longitude information from device's IP address.

@@ -70,10 +71,14 @@ Use the `WEATHER_FONT` variable to customize the font used in weather display mo

`LOCALE` variable allows to display the date of temperature reading in any language supported by [the date library](https://arrow.readthedocs.io/en/latest/#module-arrow.locales).

Set `ALTERNATE_FREQUENCY` to alternate the display mode between quote and weather. Inkyshot uses this environment variable's number value as minutes to update periodically. By default, the first display is quote mode and you can instead chose weather by setting `NEXT_DISPLAY` to `weather`.
Finally, you can set the environment variable `MODE` to `alternate` for Inkyshot to rotate between `quote` and `weather` modes.
You can put number of minutes in the `ALTERNATE_FREQUENCY` environment variable in order to configure Inkyshot to update periodically.
By default, the first display is quote mode and you can instead chose weather by setting `current_display` tag to `weather` on the device.


Finally, you can choose to fix Inkyshot to display only weather. Set `NEXT_DISPLAY` to `weather`, `DISPLAY_QUOTE` to false and don't set `INKY_MESSAGE`. In this setup, inkyshot will keep updating weather information after every minutes set by `ALTERNATE_FREQUENCY`.
### Wifi Connect

As from v1.2.0 this project includes [wifi-connect](https://github.com/balena-io/wifi-connect) which is a utility for dynamically setting the WiFi configuration on a Linux device via a captive portal. If your device is not connected to the internet, an access point will be created. You can refer to the docs [here](https://github.com/balenablocks/wifi-connect#customisation) for customizing the different settings for wifi-connect.

## Case

@@ -91,7 +96,7 @@ A position is open in the rear of the case for the use of a [micro USB PCB socke

_When submitting a pull request, please use the guidance outlined below._

Each commit message should consist of a *body* and a *footer*, structured in the following format:
Each commit message should consist of a _body_ and a _footer_, structured in the following format:

```
<scope (optional)>: <subject (mandatory)>
@@ -107,10 +112,10 @@ Each commit message should consist of a *body* and a *footer*, structured in the

Quotes are delivered from the
<span style="z-index:50;font-size:0.9em; font-weight: bold;">
<img src="https://theysaidso.com/branding/theysaidso.png" height="20" width="20" alt="theysaidso.com"/>
<a href="https://theysaidso.com" title="Powered by quotes from theysaidso.com" style="color: #ccc; margin-left: 4px; vertical-align: middle;">
They Said So®
</a>
<img src="https://theysaidso.com/branding/theysaidso.png" height="20" width="20" alt="theysaidso.com"/>
<a href="https://theysaidso.com" title="Powered by quotes from theysaidso.com" style="color: #ccc; margin-left: 4px; vertical-align: middle;">
They Said So®
</a>
</span> REST API.

Location information based on IP address is retrieved from [ipinfo.io](https://ipinfo.io).
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.4.2
1.3.2
22 changes: 22 additions & 0 deletions balena.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
version: "2"
slug: "inkyshot"
name: "Inkyshot"
type: "sw.application"
assets:
- url: "https://github.com/balenalabs/inkyshot"
name: "repository"
- url: "https://raw.githubusercontent.com/balenalabs/inkyshot/master/logo.png"
name: "logo"
data:
description: "Get a daily random inspirational quote delivered direct to your desk with Inkyshot. Build multiple Inkyshots and share the inspiration with your friends, family and loved ones ❤️"
applicationEnvironmentVariables:
- UPDATE_HOUR: 9
- TZ: 'Europe/London'
- QOD_CATEGORY: 'inspire'
- FONT: 'AmaticSC'
- TEST_CHARACTER: 'a'
defaultDeviceType: "raspberry-pi"
supportedDeviceTypes:
- "raspberry-pi"
- "raspberrypi3"
- "fincm3"
18 changes: 18 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: '2.1'
services:
inkyshot:
build:
context: ./inkyshot
privileged: true
labels:
io.balena.features.balena-api: '1'
io.balena.features.supervisor-api: '1'
wifi-connect:
build:
context: ./wifi-connect
restart: always
network_mode: host
privileged: true
labels:
io.balena.features.dbus: '1'
io.balena.features.firmware: '1'
File renamed without changes.
File renamed without changes.
Binary file added inkyshot/fonts/LinLibertine_DR.otf
Binary file not shown.
Binary file added inkyshot/fonts/basis33.ttf
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
26 changes: 26 additions & 0 deletions inkyshot/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
arrow==0.15.7
certifi==2020.6.20
chardet==3.0.4
click==7.1.2
decorator==4.4.2
font-amatic-sc==0.0.4
font-caladea==0.0.2
font-fredoka-one==0.0.4
font-hanken-grotesk==0.0.2
font-intuitive==0.0.4
font-roboto==0.0.1
font-source-sans-pro==0.0.1
font-source-serif-pro==0.0.1
future==0.18.2
geocoder==1.38.1
idna==2.10
inky==1.0.1
numpy==1.19.2
Pillow==8.0.0
python-dateutil==2.8.1
ratelim==0.1.6
requests==2.24.0
RPi.GPIO==0.7.0
six==1.15.0
smbus2==0.3.0
spidev==3.5
Loading