Skip to content

Commit 4d8974b

Browse files
committed
UK/NA added to application registration documentation
1 parent 2c7da23 commit 4d8974b

File tree

9 files changed

+29
-25
lines changed

9 files changed

+29
-25
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
This is an alternative [integration to FordPass](https://github.com/marq24/ha-fordpass), making use of the FordConnect Query API. This API provides __read-only__ access to the vehicle data.
66
### Requirements
77
- Your car must have the latest on-board modem functionality and have been registered/authorized with the FordPass™ application
8-
- An API credential pair previously registered with the EU Ford developer portal.
8+
- An API credential pair previously registered with the EU/UK/NA Ford developer portal.
99
10-
Further information can be found in [_the Application Registration Guide_. This includes a step-by-step procedure](https://github.com/marq24/ha-fordconnect-query/blob/main/docs/REGISTER_APPLICATION.md) to register an application at Fords EU developer portal.
10+
Further information can be found in [_the Application Registration Guide_. This includes a step-by-step procedure](https://github.com/marq24/ha-fordconnect-query/blob/main/docs/REGISTER_APPLICATION.md) to register an application at Fords EU/UK/NA developer portal.
1111
### Need further instructions?
1212
All other setup details can be found in the [Integration Setup Guide](https://github.com/marq24/ha-fordconnect-query/blob/main/docs/CONFIGURE_INTEGRATION.md)
1313
### Final note
@@ -18,7 +18,7 @@ If you find this integration useful, please consider supporting me as a GitHub p
1818
Dies ist eine [alternative Integration zu FordPass](https://github.com/marq24/ha-fordpass), die die FordConnect Query API nutzt. Diese API bietet __read.only__ Zugriff auf Deine Fahrzeugdaten.
1919
### Voraussetzungen
2020
- Dein Fahrzeug muss über die neueste On-Board-Modem-Funktionalität verfügen und bei der FordPass™-Anwendung registriert/autorisiert sein.
21-
- Einen API-Schlüssel, der zuvor im EU-Ford-Entwicklerportal registriert wurde.
21+
- Einen API-Schlüssel, der zuvor im EU/UK/NA-Ford-Entwicklerportal registriert wurde.
2222
2323
Weitere Informationen findest Du [im _Application Registration Guide_. Dort findest Du auch eine Schritt-für-Schritt-Anleitung](https://github.com/marq24/ha-fordconnect-query/blob/main/docs/REGISTER_APPLICATION.md) zur Registrierung eines solchen Schlüssels.
2424
### Benötigst Du weitere Hilfe?
@@ -79,7 +79,7 @@ https://raw.githubusercontent.com/marq24/ha-fordconnect-query/refs/heads/main/do
7979
## Requirements
8080
1. Your car must have the latest on-board modem functionality and have been registered/authorized with the FordPass™/The Lincoln Way™ application.<br/>
8181
2. You need a Home Assistant instance (v2025.11 or higher) – additionally, it's also highly recommended to have the [HACS](https://hacs.xyz/docs/use/#getting-started-with-hacs) custom integration installed.<br/>
82-
3. [You __must have registered an application with Ford in the EU developer portal__](./docs/REGISTER_APPLICATION.md). [Therefore, you need to register a Ford developer account].
82+
3. [You __must have registered an application with Ford in the EU/UK/NA developer portal__](./docs/REGISTER_APPLICATION.md). [Therefore, you need to register a Ford developer account].
8383
4. You need to configure OAuth Application Credentials in HA that can be used by this integration. (will be done automatically via the integration setup)
8484

8585
> [!IMPORTANT]
@@ -124,7 +124,7 @@ Installing the integration on your Home Assistant instance can be done either vi
124124
>
125125
-->
126126
1. Search for `fordconnect` in the search bar.
127-
2. Install the 'correct' (aka 'this') __FordConnect Query (for EU)__ (v2026.1.0 or higher).
127+
2. Install the 'correct' (aka 'this') __FordConnect Query (for EU/UK/NA)__ (v2026.1.0 or higher).
128128
3. Restart HA.
129129

130130

custom_components/fordconnect_query/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@
99
"iot_class": "cloud_polling",
1010
"issue_tracker": "https://github.com/marq24/ha-fordconnect-query/issues",
1111
"requirements": [],
12-
"version": "2026.3.3"
12+
"version": "2026.3.4"
1313
}

custom_components/fordconnect_query/translations/de.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
},
7575
"user_connect": {
7676
"title": "Neues Ford Fahrzeug hinzufügen",
77-
"description": "## Willkommen zur FordConnect Query Integration\nDies ist eine [alternative Integration zu FordPass]({repo}), die die FordConnect Query API nutzt. Diese API bietet __read-only__ Zugriff auf Deine Fahrzeugdaten.\n### Voraussetzungen\n- Dein Fahrzeug muss über die neueste On-Board-Modem-Funktionalität verfügen und bei der FordPass™-Anwendung registriert/autorisiert sein.\n- Einen API-Schlüssel, der zuvor im EU-Ford-Entwicklerportal registriert wurde.\n\nWeitere Informationen findest Du [im _Application Registration Guide_. Dort findest Du auch eine Schritt-für-Schritt-Anleitung]({repo}/blob/main/docs/REGISTER_APPLICATION.md) zur Registrierung eines solchen Schlüssels.\n### Benötigst Du weitere Hilfe?\nAlle weiteren Einrichtungsdetails findest Du [hier im _Integration Setup Guide_]({repo}/blob/main/docs/CONFIGURE_INTEGRATION.md).\n### Abschließender Hinweis in eigener Sache\nWenn Du diese Integration nützlich findest, dann bitte denk doch bitte darüber nach, ob Du mich nicht vielleicht als GitHub-Projekt-Sponsor (oder auf eine der anderen in [meinem Profil@GitHub]({github})) beschriebenen Art) unerstützen möchtest – vielen Dank an die Menschen, die dies bereits tun – Ihr seid großartig!",
77+
"description": "## Willkommen zur FordConnect Query Integration\nDies ist eine [alternative Integration zu FordPass]({repo}), die die FordConnect Query API nutzt. Diese API bietet __read-only__ Zugriff auf Deine Fahrzeugdaten.\n### Voraussetzungen\n- Dein Fahrzeug muss über die neueste On-Board-Modem-Funktionalität verfügen und bei der FordPass™-Anwendung registriert/autorisiert sein.\n- Einen API-Schlüssel, der zuvor im EU/UK/NA-Ford-Entwicklerportal registriert wurde.\n\nWeitere Informationen findest Du [im _Application Registration Guide_. Dort findest Du auch eine Schritt-für-Schritt-Anleitung]({repo}/blob/main/docs/REGISTER_APPLICATION.md) zur Registrierung eines solchen Schlüssels.\n### Benötigst Du weitere Hilfe?\nAlle weiteren Einrichtungsdetails findest Du [hier im _Integration Setup Guide_]({repo}/blob/main/docs/CONFIGURE_INTEGRATION.md).\n### Abschließender Hinweis in eigener Sache\nWenn Du diese Integration nützlich findest, dann bitte denk doch bitte darüber nach, ob Du mich nicht vielleicht als GitHub-Projekt-Sponsor (oder auf eine der anderen in [meinem Profil@GitHub]({github})) beschriebenen Art) unerstützen möchtest – vielen Dank an die Menschen, die dies bereits tun – Ihr seid großartig!",
7878
"data": {
7979
"config_title": "Wähle einen Namen für den Konfigurations-Eintrag aus"
8080
}

custom_components/fordconnect_query/translations/en.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
},
7575
"user_connect": {
7676
"title": "Add a new Ford Vehicle",
77-
"description": "## Welcome to the FordConnect Query Integration\nThis is an alternative [integration to FordPass]({repo}), making use of the FordConnect Query API. This API provides __read-only__ access to the vehicle data.\n### Requirements\n- Your car must have the latest on-board modem functionality and have been registered/authorized with the FordPass™ application\n- An API credential pair previously registered with the EU Ford developer portal.\n\nFurther information can be found in [_the Application Registration Guide_. This includes a step-by-step procedure]({repo}/blob/main/docs/REGISTER_APPLICATION.md) to register an application at Fords EU developer portal.\n### Need further instructions?\nAll other setup details can be found in the [Integration Setup Guide]({repo}/blob/main/docs/CONFIGURE_INTEGRATION.md)\n### Final note\nIf you find this integration useful, please consider supporting me as a GitHub project sponsor (or in one of the other ways [described here in my profile@GitHub]({github})) – thank you to those who already do – you're all amazing!",
77+
"description": "## Welcome to the FordConnect Query Integration\nThis is an alternative [integration to FordPass]({repo}), making use of the FordConnect Query API. This API provides __read-only__ access to the vehicle data.\n### Requirements\n- Your car must have the latest on-board modem functionality and have been registered/authorized with the FordPass™ application\n- An API credential pair previously registered with the EU/UK/NA Ford developer portal.\n\nFurther information can be found in [_the Application Registration Guide_. This includes a step-by-step procedure]({repo}/blob/main/docs/REGISTER_APPLICATION.md) to register an application at Fords EU developer portal.\n### Need further instructions?\nAll other setup details can be found in the [Integration Setup Guide]({repo}/blob/main/docs/CONFIGURE_INTEGRATION.md)\n### Final note\nIf you find this integration useful, please consider supporting me as a GitHub project sponsor (or in one of the other ways [described here in my profile@GitHub]({github})) – thank you to those who already do – you're all amazing!",
7878
"data": {
7979
"config_title": "Please select a name for your Configuration entry"
8080
}

custom_components/fordconnect_query/translations/fr.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
},
7575
"user_connect": {
7676
"title": "Ajouter un nouveau véhicule Ford",
77-
"description": "## Bienvenue dans l'intégration FordConnect Query\nCeci est une intégration alternative à FordPass ({repo}), utilisant l'API FordConnect Query. Cette API fournit un accès __en lecture seule__ aux données du véhicule.\n### Exigences\n- Votre véhicule doit disposer du dernier modem embarqué et être enregistré/autorisé avec l'application FordPass™\n- Une paire d'identifiants API préalablement enregistrée sur le portail développeur Ford EU.\n\nVous trouverez plus d'informations dans le [_guide d'enregistrement d'application_], qui inclut une procédure pas à pas: {repo}/blob/main/docs/REGISTER_APPLICATION.md.\n### Besoin d'instructions supplémentaires ?\nTous les autres détails d'installation se trouvent dans le [guide de configuration]({repo}/blob/main/docs/CONFIGURE_INTEGRATION.md)\n### Remarque finale\nSi vous trouvez cette intégration utile, envisagez de me soutenir en tant que sponsor GitHub (ou d'une autre manière décrite sur mon profil GitHub) – merci à ceux qui le font déjà !",
77+
"description": "## Bienvenue dans l'intégration FordConnect Query\nCeci est une intégration alternative à FordPass ({repo}), utilisant l'API FordConnect Query. Cette API fournit un accès __en lecture seule__ aux données du véhicule.\n### Exigences\n- Votre véhicule doit disposer du dernier modem embarqué et être enregistré/autorisé avec l'application FordPass™\n- Une paire d'identifiants API préalablement enregistrée sur le portail développeur Ford EU/UK/NA.\n\nVous trouverez plus d'informations dans le [_guide d'enregistrement d'application_], qui inclut une procédure pas à pas: {repo}/blob/main/docs/REGISTER_APPLICATION.md.\n### Besoin d'instructions supplémentaires ?\nTous les autres détails d'installation se trouvent dans le [guide de configuration]({repo}/blob/main/docs/CONFIGURE_INTEGRATION.md)\n### Remarque finale\nSi vous trouvez cette intégration utile, envisagez de me soutenir en tant que sponsor GitHub (ou d'une autre manière décrite sur mon profil GitHub) – merci à ceux qui le font déjà !",
7878
"data": {
7979
"config_title": "Veuillez choisir un nom pour votre entrée de configuration"
8080
}

custom_components/fordconnect_query/translations/nl.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
},
7575
"user_connect": {
7676
"title": "Voeg een nieuw Ford-voertuig toe",
77-
"description": "## Welkom bij de FordConnect Query-integratie\nDit is een alternatief [integratie naar FordPass]({repo}), met gebruik van de FordConnect Query API. Deze API biedt __alleen-lezen__ toegang tot voertuiggegevens.\n### Vereisten\n- Uw auto moet de nieuwste on-board modem-functionaliteit hebben en moet zijn geregistreerd/geautoriseerd bij de FordPass™-toepassing\n- Een API-referentiepaar dat eerder is geregistreerd bij de EU Ford-ontwikkelaarportal.\n\nVerdere informatie is te vinden in [_de handleiding Toepassingsregistratie_. Dit bevat een stapsgewijze procedure]({repo}/blob/main/docs/REGISTER_APPLICATION.md) om een toepassing in Fords EU-ontwikkelaarportal in te schrijven.\n### Hebt u verdere instructies nodig?\nAlle andere instellingsdetails vindt u in de [Gids voor integratieinstelling]({repo}/blob/main/docs/CONFIGURE_INTEGRATION.md)\n### Eindopmerking\nAls u deze integratie nuttig vindt, overweeg dan mij te ondersteunen als GitHub-projectsponsor (of op een van de andere manieren [beschreven in mijn profiel@GitHub]({github})) – dank aan degenen die dit al doen – jullie zijn allemaal geweldig!",
77+
"description": "## Welkom bij de FordConnect Query-integratie\nDit is een alternatief [integratie naar FordPass]({repo}), met gebruik van de FordConnect Query API. Deze API biedt __alleen-lezen__ toegang tot voertuiggegevens.\n### Vereisten\n- Uw auto moet de nieuwste on-board modem-functionaliteit hebben en moet zijn geregistreerd/geautoriseerd bij de FordPass™-toepassing\n- Een API-referentiepaar dat eerder is geregistreerd bij de EU/UK/NA Ford-ontwikkelaarportal.\n\nVerdere informatie is te vinden in [_de handleiding Toepassingsregistratie_. Dit bevat een stapsgewijze procedure]({repo}/blob/main/docs/REGISTER_APPLICATION.md) om een toepassing in Fords EU-ontwikkelaarportal in te schrijven.\n### Hebt u verdere instructies nodig?\nAlle andere instellingsdetails vindt u in de [Gids voor integratieinstelling]({repo}/blob/main/docs/CONFIGURE_INTEGRATION.md)\n### Eindopmerking\nAls u deze integratie nuttig vindt, overweeg dan mij te ondersteunen als GitHub-projectsponsor (of op een van de andere manieren [beschreven in mijn profiel@GitHub]({github})) – dank aan degenen die dit al doen – jullie zijn allemaal geweldig!",
7878
"data": {
7979
"config_title": "Selecteer alstublieft een naam voor uw configuratie-invoer"
8080
}

docs/CONFIGURE_INTEGRATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ___These are just example credentials – and they will not work – don't waste
2020

2121
or
2222
1. Go to `Settings` -> `Devices & Services` area
23-
2. Add the new integration `FordConnect Query (for EU)`
23+
2. Add the new integration `FordConnect Query (for EU/UK/NA)`
2424

2525
### Continue with the configuration
2626
The first thing you will be requested to do is to configure the application credentials in Home Assistant for the integration. Once this is done, your credentials will be stored by HA and can be used by the integration at any time.

0 commit comments

Comments
 (0)