mia/bumper
1
0
Fork 0
Code Issues 47 Pull requests 11 Projects Releases Packages Wiki Activity Actions
bumper/docs/DNS_Setup.md
Robert Resch df36bdd29d
add new endpoints for app v2 (#116) 
* add some new endpoints for app v2

* add oauth

* update EcoVacsHomeProducts
- new attribute model

* add some missing endpoints for app v2

* - use only one level subdomain urls on service list
- add status

* add new used subdomains (for europe)

* improve docker images creation as requirements are change less often

* reformat area list

* add revoke expired oauths

* add docker-compose example

* wait for mqtt start fixes #107

* make images even smaller by copying only required folders instead of all (.git,...)

* fix exception during logging

* return fail if we can't get clean logs

* improve docker docs. Thanks for the hit @Bustel

* fix body not json serializable

* add docker-compose example in separate folder
2021-06-05 09:06:18 -04:00

4.6 KiB
Raw Permalink Blame History

DNS

You need to configure your router to point DNS locally to where Bumper is running.
The easiest way is overriding the main domains used by EcoVacs using DNSMasq/PiHole, by adding address entries in a custom config.

Custom DNSMasq Config

Typically written at /etc/dnsmasq.d/{##}-{name}.conf

  • Ex: /etc/dnsmasq.d/02-custom.conf

File Contents:

address=/ecouser.net/{bumper server ip}
address=/ecovacs.com/{bumper server ip}
address=/ecovacs.net/{bumper server ip}

Note: Replace {bumper server ip} with your server's IP

If using PiHole, reload FTL to apply changes:

sudo service pihole-FTL reload

Manual Override

If overriding DNS for the top-level domains isn't an option, you'll need to configure your router DNS to point a number of domains used by the app/robot to the Bumper server.

Note: Depending on country, your phone/robot may be using a different domain. Most of these domains contain country-specific placeholders.

Not all domains have been documented at this point, and this list will be updated as more are identified/seen. The preferred way to ensure Bumper works is to override the full domains as above. Note: The app dynamically gets the required domains from the endpoint api/appsvr/service/list and therefore ecovacs can use different domains for different models.

Replacement Examples:

  • {countrycode}
    • If you see eco-{countrycode}-api.ecovacs.com and you live in the US/North America you would use: eco-us-api.ecovacs.com
    • Note: {countrycode} may also be generalized regions such as "EU".
  • {region}
    • If you see portal-{region}.ecouser.net and you live in the US/North America you would use: portal-na.ecouser.net
    • Note: {region} may also be generalized regions such as "EU".
Address Description
lb-{countrycode}.ecovacs.net Load-balancer that is checked by the app/robot
lb-{countrycode}.ecouser.net Load-balancer that is checked by the app/robot
lbus.ecouser.net Load-balancer that is checked by the app/robot
lb{countrycode}.ecouser.net Load-balancer that is checked by the app/robot
eco-{countrycode}-api.ecovacs.com Used for Login
gl-{countrycode}-api.ecovacs.com Used by EcoVacs Home app
gl-{countrycode}-openapi.ecovacs.com Used by EcoVacs Home app
portal.ecouser.net Used for Login and Rest API
portal-{countrycode}.ecouser.net Used for Login and Rest API
portal-{region}.ecouser.net Used for Login and Rest API
portal-ww.ecouser.net Used for various Rest APIs
msg-{countrycode}.ecouser.net Used for XMPP
msg-{region}.ecouser.net Used for XMPP
msg-ww.ecouser.net Used for XMPP
mq-{countrycode}.ecouser.net Used for MQTT
mq-{region}.ecouser.net Used for MQTT
mq-ww.ecouser.net Used for MQTT
gl-{countrycode}-api.ecovacs.com Used by Ecovacs Home app for API
recommender.ecovacs.com Used by Ecovacs Home app
bigdata-international.ecovacs.com Telemetry/tracking
bigdata-northamerica.ecovacs.com Telemetry/tracking
bigdata-europe.ecovacs.com Telemetry/tracking
bigdata-{unknown regions}.ecovacs.com Telemetry/tracking
api-app.ww.ecouser.net Api for App (v2+)
api-app.dc-{region}.ww.ecouser.net Api for App (v2+)
users-base.dc-{region}.ww.ecouser.net Accounts for App (v2+)
jmq-ngiot-{region}.dc.ww.ecouser.net MQTT for App (v2+)
api-rop.dc-{region}.ww.ecouser.net App (v2+)
jmq-ngiot-{region}.area.ww.ecouser.net App (v2+)