Update README

This commit is contained in:
April Wormwood 2022-11-27 22:01:17 -07:00
parent 9b6e1aa459
commit 58eb901706
No known key found for this signature in database
GPG Key ID: 17A9A017FAA4DE5E

View File

@ -1,33 +1,46 @@
# i2RecordCollector
This software handles data collection and processing for The Weather Channel's IntelliStar 2 software using a mix of TWC's v1, v2, and v3 APIs.
<p align="center">
<img src="https://cdn.discordapp.com/attachments/1035585006724194311/1046646391730077736/opentelecom2k_blue_clean.png">
</p>
<h1 align="center"><strong>IntelliStar 2 Data Collector</strong></h1>
<style>img {width: 80%}</style>
# Requirements
* Firewall on the stock I2 image fixed to allow incoming connections from ``224.1.1.77`` on ports ``7787`` and ``7788``
* Properly set up interface for UDP.
* [Python 3.8.0](https://www.python.org/downloads/release/python-380/)
## Records
- [x] ADRecord - Airport Delays
- [x] BERecord - Alerts
- [ ] ClimatologyRecord - Record highs/lows
- [x] DDRecord - Daypart Forecast
- [x] DFRecord - Daily Forecast (7 Day Forecast)
- [x] ESRecord - Air Quality
- [x] IDRecord - Pollen
- [x] MORecord - Current Conditions
- [x] TIRecord - Tides
- [ ] TFRecord - Traffic Flow
- [ ] TNRecord - Traffic Incidents
- [ ] WMRecord - Marine Forecast
## Completed Records
- [X] Aches and Pains
- [X] Air Quality
- [X] Airport Delays + National Airport delays
- [X] Alerts *(BERecord)*
- [X] Breathing
- [X] Current Conditions
- [X] Daily Forecasts
- [X] Hourly Forecasts
- [X] Heating and Cooling
- [X] Mosquito Activity
- [X] Pollen Forecasts
- [X] Tide Station Forecasts
- [X] Watering Needs
- [] Marine Forecasts
- [] Traffic Forecasts **(API access missing)**
# Usage instructions
[Download a release](https://github.com/Open-Telecom/i2MessageEncoder-Rewrite/releases) for the most stable version, or clone the repository.
1) Ensure that [Python 3.8 is installed](https://www.python.org/downloads/release/python-380/).
2) [Download a release](https://github.com/Open-Telecom/i2MessageEncoder-Rewrite/releases/tag/v2.0.2), and unzip to the wanted directory.
3) Use command prompt to enter the directory of the scripts, then install package requirements:<br/>
```py -3 -m pip install -r requirements.txt``` <br/>
4) Drop your unit's **MachineProductConfiguration.xml** file into the root of the script
5) Run ``main.py``
``git clone https://github.com/Open-Telecom/i2MessageEncoder-Rewrite``
### Attributions & Disclaimers
Air Quality reports are powered by Copernicus Atmosphere Monitoring Service Information 2022.
Neither the European Commission nor ECMWF is responsible for any use that may be made of the Copernicus Information or Data it contains.
*(If downloading this as a zip, extract to the directory of your choosing.)*
### Copyright Notice
Install the requirements in ``requirements.txt``
Copyright © 2022 OpenTelecom
``py -3 -m pip install -r requirements.txt``
Drop your IntelliStar 2's ``MachineProductCfg.xml`` file into the root of the directory of the encoder, then run ``main.py``.
The i2DataCollector project cannot be copied/distributed without the express permission of the OpenTelecom group.