https://github.com/gaojiafamily/ha-trem2
TREM 2 for HA Integration
https://github.com/gaojiafamily/ha-trem2
custom-component earthquake earthquake-early-warning home-assistant trem
Last synced: 2 months ago
JSON representation
TREM 2 for HA Integration
- Host: GitHub
- URL: https://github.com/gaojiafamily/ha-trem2
- Owner: gaojiafamily
- License: agpl-3.0
- Created: 2025-04-03T15:08:38.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-07T15:22:10.000Z (3 months ago)
- Last Synced: 2025-04-07T16:31:27.658Z (3 months ago)
- Topics: custom-component, earthquake, earthquake-early-warning, home-assistant, trem
- Language: Python
- Homepage: https://www.gj-smart.com
- Size: 4.03 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
Taiwan Real-time Earthquake Monitoring for HA
[![GitHub Release][releases-shield]][releases]
[![hacs_custom][hacs_custom_shield]][hacs_custom]
[![License][license-shield]](LICENSE)
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Contributors][contributors-shield]][contributors-url]
[![BuyMeCoffee][buymecoffee-shield]][buymecoffee]
English | [繁體中文](README_zhHant.md)
## Screenshots
> [!IMPORTANT]
> The source of earthquake early warning is provided by ExpTech Studio and is for reference only.
> The actual results are subject to the content published by [CWA](https://scweb.cwa.gov.tw/en-US).
> Some features require a subscription to the Enhanced Computing Service ("ECS").
## Feature
- [x] Isoseismal map image.
- [ ] Simulator earthquake service.
- [ ] Calculate arrival forecast based on your location (ECS only).
- [ ] RTS Notification (Exptech VIP only).
- [ ] Tsunami Notification (Exptech VIP only).
## Prerequisite
> [!IMPORTANT]
> Before installing this integration, please ensure your environment meets the necessary requirements for dependencies and fonts.
> Detailed instructions are provided in the [Prerequisite Documentation](Prerequisite.md).
> [!NOTE]
> We are actively working on a proposal to pre-install these dependencies in the Home Assistant Core.
> This will reduce manual setup requirements. See [Community Proposal](#community-proposal-pre-install-dependencies-in-home-assistant-core) for details.
## Installation
### Using [HACS](https://hacs.xyz/) (recommended)
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=gaojiafamily&repository=ha-trem2&category=Integration)
### Manual
1. Create `config/custom_components` folder if not existing.
2. Copy `trem2` into `custom_components` folder.
## Config
**Please use the config flow of Home Assistant.**
With GUI. Configuration > Integration > Add Integration > Taiwan Real-time Earthquake Monitoring 2
- If the integration didn't show up in the list please REFRESH the page
- If the integration is still not in the list, you need to clear the browser cache.
## Data Source
- [x] Http protocol
- [ ] Websocket protocol (Exptech VIP only)
- [ ] Custom server (ECS only)
## Known issues
- [ ] Todo: [Pre-install Dependencies in Home Assistant Core](#community-proposal-pre-install-dependencies-in-home-assistant-core)
*An API server can be monitored [here](https://status.exptech.dev).*
## Community Proposal: Pre-install Dependencies in Home Assistant Core
To simplify the installation process for users and developers, we propose adding the following dependencies to the default Home Assistant Core:
### System-level Dependencies:
- **cairo**: Required for font rendering and SVG processing.
### Benefits:
1. Reduces manual setup steps, especially for non-technical users.
2. Ensures compatibility with integrations and custom components that rely on these dependencies.
3. Enhances developer productivity by providing a ready-to-use environment.
### Next Steps:
We plan to submit this proposal to the Home Assistant GitHub repository as a Feature Request. This will include testing results and detailed reasoning to support the inclusion of these dependencies in the official Docker image.
### ECS/Exptech VIP
Based on the donate amount, every $15 grants six months of ECS access.
> [!NOTE]
> ECS access will be released soon.
You can goto https://exptech.com.tw/pricing to subscribe Exptech VIP.
## Donate
| Buy me a coffee | LINE Bank | JAKo Pay |
| :------------: | :------------: | :------------: |
| 
| 
| 
|
## Contribution
- ExpTech Studio `Data Source`
I would like to thank everyone who has helped me and every partner in the community for their generous help.
## License
This is an open-source client tool licensed under the AGPL-3.0 license, allowing anyone to freely use, modify, and distribute it.
This tool requires a subscription to use our enhanced computing service.
**2024-08-15 Agreement reached with ExpTech Studio.**
[releases-shield]: https://img.shields.io/github/release/gaojiafamily/ha-trem2.svg?style=for-the-badge
[releases]: https://github.com/gaojiafamily/ha-trem2/releases
[hacs_custom_shield]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge
[hacs_custom]: https://hacs.xyz/docs/faq/custom_repositories
[stars-shield]: https://img.shields.io/github/stars/gaojiafamily/ha-trem2.svg?style=for-the-badge
[stars-url]: https://github.com/gaojiafamily/ha-trem2/stargazers
[issues-shield]: https://img.shields.io/github/issues/gaojiafamily/ha-trem2.svg?style=for-the-badge
[issues-url]: https://github.com/gaojiafamily/ha-trem2/issues
[contributors-shield]: https://img.shields.io/github/contributors/gaojiafamily/ha-trem2.svg?style=for-the-badge
[contributors-url]: https://github.com/gaojiafamily/ha-trem2/graphs/contributors
[license-shield]: https://img.shields.io/github/license/gaojiafamily/ha-trem2.svg?style=for-the-badge
[buymecoffee-shield]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[buymecoffee]: https://www.buymeacoffee.com/j1at13n