Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gaojiafamily/ha-trem

Taiwan Real-time Earthquake Monitoring for HA Integration
https://github.com/gaojiafamily/ha-trem

custom-component earthquake earthquake-early-warning home-assistant trem

Last synced: about 1 month ago
JSON representation

Taiwan Real-time Earthquake Monitoring for HA Integration

Host: GitHub
URL: https://github.com/gaojiafamily/ha-trem
Owner: gaojiafamily
License: agpl-3.0
Created: 2024-08-15T13:41:14.000Z (5 months ago)
Default Branch: master
Last Pushed: 2024-10-23T15:15:22.000Z (2 months ago)
Last Synced: 2024-10-23T19:34:38.538Z (2 months ago)
Topics: custom-component, earthquake, earthquake-early-warning, home-assistant, trem
Language: Python
Homepage:
Size: 590 KB
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- 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


![Logo](https://raw.githubusercontent.com/gaojiafamily/ha-trem/master/docs/media/logo.png)

[![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

![config_flow_image](https://github.com/user-attachments/assets/9d92c830-7318-4baf-add7-a07d1e2d2673)

![simulator_earthquake_demo](https://github.com/user-attachments/assets/c05ca3a5-b0aa-4e4f-9376-59c2f31ef536)

[Demo video](https://youtu.be/3MvTdGuDs7s)






> [!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).






## Feature

- [x] Isoseismal map image (can also be saved as file).

- [x] Simulator earthquake service.

- [x] RTS Notification (Exptech VIP Only).

- [x] Tsunami Notification (Exptech VIP Only).






## Available

| Environment | Home Assistant OS | Home Assistant Core | Home Assistant Supervisor |

| :------------: | :------------: | :------------: | :------------: |

| Virtual Machine[^1] | :heavy_check_mark: |  |  |

| Container |  | :heavy_check_mark: | :question:[^2] |

| Virtual Environment |  | :heavy_check_mark: |  |

| Physics Machine[^3] | :question:[^4] | :heavy_minus_sign:[^5] | :question:[^2] |

:heavy_check_mark: Available


:heavy_multiplication_x: Unavailable


:question: Untested


:heavy_minus_sign: See footnotes


[^1]: Virtual Machine may include but not limited to: VirtualBox、Unraid、KVM/Proxmox、UTM...etc.

[^2]: If your installation method is [it](https://github.com/home-assistant/supervised-installer).

[^3]: Physics Machine may include but not limited to: Raspberry Pi、Home Assistant Green、Home Assistant Yellow...etc.

[^4]: So far, only known rpi4 4GB is available.

[^5]: If your installation method on other systems, Hope you can provide feedback.






## Prerequisite (if you're using HAOS)

**Manual install dependencies see [here](docs/haos_guide.md).**

> [!IMPORTANT]

> This custom component installation is considered advanced


> should only be used if one is an expert in managing a Linux operating system.

> /tmp is mounted noexec on HAOS so it can't compile, A [workaround](https://github.com/home-assistant/core/issues/118717) is to do this inside the container.






## Installation

### Using [HACS](https://hacs.xyz/) (recommended)

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=gaojiafamily&repository=ha-trem&category=Integration)

### Manual

1. Create `config/custom_components` folder if not existing.

2. Copy `trem` into `custom_components` folder.






## Config

**Please use the config flow of Home Assistant.**

1. With GUI. Configuration > Integration > Add Integration > Taiwan Real-time Earthquake Monitoring

   - 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.

*A Region code can be search [here](https://github.com/ExpTechTW/API/blob/master/resource/region.json).*







## Data Source

- [x] HTTPS API (or use your self-server)

- [x] Websocket. (Exptech VIP Only)

### HTTPS API

| Node               | Description                                 |

| :----------------: | :-----------------------------------------: |

| tainan_cache_limit | The number of requests is limited           |

| tainan_cache       | Available to all users                      |

| taipe_cache_limit  | The number of requests is limited           |

| taipe_cache        | Available to all users                      |

| taipei_limit       | The number of requests is limited           |

| taipei             | The data is real-time but the load is high  |

| taipei_2           | The data is real-time but the load is high  |

| pingtung_limit     | The number of requests is limited           |

| pingtung           | The data is real-time but the load is high  |

| pingtung_2         | The data is real-time but the load is high  |

### Websocket

**Exptech VIP Only**

You can goto [https://exptech.com.tw/pricing](https://exptech.com.tw/pricing) to subscribe.




*An API server can be monitored [here](https://status.exptech.dev).*






## Known issues

1. Not support Home Assistant 2024.8 and higher yet.






## Contribution

- ExpTech Studio `Data Source`

- watermelon1024 `Contributor`

- kukuxx `Test Partner`

I would like to thank everyone who has helped me and every partner in the community for their generous help.







## Donate

| Buy me a coffee | LINE Bank | JAKo Pay |

| :------------: | :------------: | :------------: |

|   |   |   |






## License

AGPL-3.0 license

**2024-08-15 Agreement reached with ExpTech Studio.**

[releases-shield]: https://img.shields.io/github/release/gaojiafamily/ha-trem.svg?style=for-the-badge

[releases]: https://github.com/gaojiafamily/ha-trem/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-trem.svg?style=for-the-badge

[stars-url]: https://github.com/gaojiafamily/ha-trem/stargazers

[issues-shield]: https://img.shields.io/github/issues/gaojiafamily/ha-trem.svg?style=for-the-badge

[issues-url]: https://github.com/gaojiafamily/ha-trem/issues

[contributors-shield]: https://img.shields.io/github/contributors/gaojiafamily/ha-trem.svg?style=for-the-badge

[contributors-url]: https://github.com/gaojiafamily/ha-trem/graphs/contributors

[license-shield]: https://img.shields.io/github/license/gaojiafamily/ha-trem.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