-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add eveonline integration #44340
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
Closed
ronaldvdmeer
wants to merge
18
commits into
home-assistant:next
from
ronaldvdmeer:add-eveonline-integration
Closed
Add eveonline integration #44340
Changes from 2 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
d3d5c97
Add Eve Online integration documentation
ronaldvdmeer ba04563
Add ha_quality_scale and troubleshooting section
ronaldvdmeer 91fbd23
Fix documentation wording per review
ronaldvdmeer 29f06d3
Update docs to match current integration (sensor-only, no diagnostics)
ronaldvdmeer 3a07a1e
Merge branch 'next' into add-eveonline-integration
ronaldvdmeer 1d8b1ef
Improve eveonline docs: fix ha_release, details block, config_basic, …
ronaldvdmeer 86f8c2b
Fix Eve Online developer portal setup steps to match current UI
ronaldvdmeer 28b43d6
Mention daily downtime (11:00-11:15 UTC) in troubleshooting
ronaldvdmeer 13ded1b
Mention extended downtime on patch days in troubleshooting
ronaldvdmeer 1be41bd
Merge branch 'next' into add-eveonline-integration
ronaldvdmeer 11646f5
Remove server status sensors from Eve Online integration docs
ronaldvdmeer 161970e
Add notes about scope future-proofing and credential privacy
ronaldvdmeer c4bfe56
Move future-proof scope note after step 8 to fix list numbering
ronaldvdmeer 3b82d11
Add automation examples to Eve Online integration docs
ronaldvdmeer adb179b
Update wallet balance threshold to 100,000,000 ISK in example
ronaldvdmeer f981ce9
Add from: null to jump fatigue trigger to prevent false fires on restart
ronaldvdmeer 5a766db
Fix jump fatigue example: use time trigger instead of state trigger
ronaldvdmeer 20d5266
Add blank line before credential privacy note for spacing
ronaldvdmeer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| --- | ||
| title: Eve Online | ||
| description: Instructions on how to integrate Eve Online with Home Assistant. | ||
| ha_release: "2026.5" | ||
| ha_category: | ||
| - Sensor | ||
| ha_iot_class: Cloud Polling | ||
| ha_config_flow: true | ||
| ha_codeowners: | ||
| - '@ronaldvdmeer' | ||
| ha_domain: eveonline | ||
| ha_platforms: | ||
| - binary_sensor | ||
| - diagnostics | ||
| - sensor | ||
| ha_integration_type: hub | ||
| ha_quality_scale: bronze | ||
| --- | ||
|
|
||
| The **Eve Online** {% term integration %} allows you to monitor [Eve Online](https://www.eveonline.com/) server status and character data in Home Assistant. Eve Online is a massively multiplayer online game by CCP Games. This integration uses the [Eve Swagger Interface (ESI)](https://esi.evetech.net/) API to retrieve data about the Tranquility server and your characters. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - An Eve Online account. You can create one at [eveonline.com](https://www.eveonline.com/). | ||
| - An Eve Online developer application for OAuth2 authentication. Instructions for that are in the next step. | ||
|
|
||
| ### Create an Eve Online developer application | ||
|
|
||
| For Home Assistant to communicate with Eve Online, you need to create an application at the Eve Online developer portal. This provides you with the application credentials Home Assistant needs to allow you to log in with your Eve Online account. | ||
|
|
||
| 1. Log in to the [Eve Online Developer Portal](https://developers.eveonline.com/). | ||
|
|
||
| 2. Select **Create New Application**. | ||
|
|
||
| 3. Enter a name and description for your application. | ||
|
|
||
| 4. Under **Connection Type**, select **Authentication & API Access**. | ||
|
|
||
| 5. Add the following **Permissions (Scopes)**: | ||
|
|
||
| - `esi-location.read_location.v1` | ||
| - `esi-location.read_ship_type.v1` | ||
| - `esi-location.read_online.v1` | ||
| - `esi-skills.read_skills.v1` | ||
| - `esi-skills.read_skillqueue.v1` | ||
| - `esi-clones.read_clones.v1` | ||
| - `esi-wallet.read_character_wallet.v1` | ||
| - `esi-characters.read_standings.v1` | ||
| - `esi-characters.read_corporation_roles.v1` | ||
| - `esi-killmails.read_killmails.v1` | ||
|
|
||
| 6. Set the **Callback URL** to: | ||
|
|
||
| `https://my.home-assistant.io/redirect/oauth` | ||
|
|
||
| 7. Select **Create Application**. | ||
|
|
||
| 8. On the application details page, note the **Client ID** and **Secret Key**. You will need these during the integration setup in Home Assistant. | ||
|
|
||
| {% details "I have manually disabled My Home Assistant" %} | ||
|
|
||
| If you don't have [My Home Assistant](/integrations/my) on your installation, | ||
| you can use `<HOME_ASSISTANT_URL>/auth/external/callback` as the callback URL | ||
| instead. | ||
|
|
||
| The `<HOME_ASSISTANT_URL>` must be the same as used during the configuration/ | ||
|
ronaldvdmeer marked this conversation as resolved.
|
||
| authentication process. | ||
|
|
||
| Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://homeassistant.local:8123/auth/external/callback`. | ||
|
ronaldvdmeer marked this conversation as resolved.
|
||
|
|
||
| {% enddetails %} | ||
|
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| ## Supported functionality | ||
|
|
||
| The integration creates two devices: one for the Tranquility server, and one for each character you add. | ||
|
|
||
| ### Server sensors | ||
|
|
||
| - **Players online** | ||
| - **Description**: The number of players currently online on Tranquility. | ||
|
|
||
| - **Server version** | ||
| - **Description**: The current server version of Tranquility. | ||
|
|
||
| - **Start time** | ||
| - **Description**: The time the server was last started. | ||
|
|
||
| ### Server binary sensors | ||
|
|
||
| - **Server VIP mode** | ||
| - **Description**: Whether the Tranquility server is in VIP mode. | ||
| - **Remarks**: This entity is disabled by default. | ||
|
|
||
| ### Character sensors | ||
|
|
||
| - **Wallet balance** | ||
| - **Description**: The ISK balance of your character's wallet. | ||
|
|
||
| - **Skill points** | ||
| - **Description**: The total number of skill points your character has. | ||
|
|
||
| - **Skill queue** | ||
| - **Description**: The number of skills currently in your character's skill queue. | ||
|
|
||
| - **Current ship** | ||
| - **Description**: The name of the ship type your character is currently flying. | ||
|
|
||
| - **Location** | ||
| - **Description**: The solar system your character is currently in. | ||
|
|
||
| - **Clone location** | ||
| - **Description**: The station or structure where your character's active clone is located. | ||
|
|
||
| - **Security status** | ||
| - **Description**: Your character's current security status. | ||
|
|
||
| - **Corporation** | ||
| - **Description**: The corporation your character is a member of. | ||
|
|
||
| - **Alliance** | ||
| - **Description**: The alliance your character's corporation belongs to. | ||
|
|
||
| - **Birthday** | ||
| - **Description**: The date your character was created. | ||
|
|
||
| - **Current ship name** | ||
| - **Description**: The custom name of your character's current ship. | ||
|
|
||
| - **Unread mail** | ||
| - **Description**: The number of unread mail messages. | ||
| - **Remarks**: This entity is disabled by default. | ||
|
|
||
| - **Jump fatigue** | ||
| - **Description**: Your character's jump fatigue expiry time. | ||
| - **Remarks**: This entity is disabled by default. | ||
|
|
||
| - **Active implants** | ||
| - **Description**: The number of active implants your character has. | ||
| - **Remarks**: This entity is disabled by default. | ||
|
|
||
| ### Character binary sensors | ||
|
|
||
| - **Online** | ||
| - **Description**: Whether your character is currently online. | ||
|
|
||
| ## Using multiple characters | ||
|
|
||
| This integration supports multiple Eve Online characters. You don't need to create another developer application. To add an additional character, add the integration again and log in with a different character. | ||
|
|
||
| ## Data updates | ||
|
|
||
| The integration {% term polling polls %} data from the Eve Online ESI API every 60 seconds. | ||
|
|
||
| ## Known limitations | ||
|
|
||
| - The integration only connects to the Tranquility server (the main live server). Singularity (test server) is not supported. | ||
| - Some character data may be delayed due to ESI API caching. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### OAuth2 callback error | ||
|
|
||
| If you get an error during the OAuth2 login flow, make sure the **Callback URL** in your Eve Online developer application is set to exactly: | ||
|
|
||
| `https://my.home-assistant.io/redirect/oauth` | ||
|
|
||
| Also ensure that [My Home Assistant](/integrations/my) is correctly configured and can reach your Home Assistant instance. | ||
|
|
||
| ### Entities show as unavailable | ||
|
|
||
| If all entities become unavailable, the ESI API may be experiencing downtime. Check the [Eve Online server status](https://login.eveonline.com/) page. If the issue persists, try reauthenticating via **Settings** > **Devices & services** > **Eve Online** > **Reconfigure**. | ||
|
|
||
| ## Removing the integration | ||
|
|
||
| This integration follows standard integration removal, no extra steps are required. | ||
|
|
||
| {% include integrations/remove_device_service.md %} | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.