jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-30 14:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/aftership.markdown
Franck Nijhof c464056402
Making our website faster, cleaner and prettier (#9853) 
* 🔥 Removes octopress.js

* 🔥 Removes use of root_url var

* 🔥 Removes Octopress generator reference from feed

* 🔥 Removes delicious support

* 🔥 Removes support for Pinboard

* 🔥 Removes support for Disqus

* 🔥 Removes support for Google Plus

* ↩️ Migrate custom after_footer to default template

* ↩️ Migrate custom footer to default template

* ↩️ Migrate custom header to default template

* 🔥 Removes unused template files

* 🚀 Places time to read directly in post template

* 🚀 Removes unneeded capture from archive_post.html template

* 🔥 🚀 Removes unused, but heaving sorting call in component page

* 🚀 Merged javascripts into a single file

* 🔥 Removes more uses of root_url

* 🚀 Removal of unneeded captures from head

* 🔥 🚀 Removal of expensive liquid HTML compressor

* 🔥 Removes unneeded templates

* 🚀 Replaces kramdown with GitHub's CommonMark 🚀

* 💄 Adds Prism code syntax highlighting

* ✨ Adds support for redirect in Netlify

* ↩️ 🔥 Let Netlify handle all developer doc redirects

* ✏️ Fixes typo in redirects file: Netify -> Netlify

* 🔥 Removes unused .themes folder

* 🔥 Removes unused aside.html template

* 🔥 Removes Disqus config leftover

* 🔥 Removes rouge highlighter config

* 🔥 Removes Octopress 🎉

* 💄 Adjust code block font size and adds soft wraps

* 💄 Adds styling for inline code blocks

* 💄 Improve styling of note/warning/info boxes + div support

* 🔨 Rewrites all note/warning/info boxes
2019-07-15 22:17:54 +02:00

2.4 KiB
Raw Blame History

title, description, logo, ha_category, ha_release, ha_iot_class, redirect_from
title description logo ha_category ha_release ha_iot_class redirect_from
AfterShip Sensor Instructions on how to set up AfterShip sensors within Home Assistant. aftership.png
Postal Service
0.85 Cloud Polling
/components/sensor.aftership/

The aftership platform allows one to track deliveries by AfterShip, a service that supports 490+ couriers worldwide. It is free to use up to 100 tracked packages per month, after that there is a fee.

The sensor value shows the number of packages that are not in Delivered state. As attributes are the number of packages per status.

Setup

To use this sensor, you need an AfterShip Account and set up an API Key. To set up an API Key go to AfterShip API page, and copy existing key or generate a new one.

AfterShip recently started requiring having a credit card on file even if you are only using the free plan. That does not change the functionality of the platform, just something to be aware of.

Configuration

To enable this sensor, add the following lines to your configuration.yaml:

sensor:
  - platform: aftership
    api_key: AFTERSHIP_APIKEY

{% configuration %} name: description: The sensor name to use in the frontend. required: false default: "aftership" type: string api_key: description: The API key for AfterShip. required: true type: string {% endconfiguration %}

Service add_tracking

You can use the service aftership.add_tracking to add trackings to Aftership.

Service data attribute Required Type Description
tracking_number True string Tracking number
slug False string Carrier e.g. fedex
title False string Friendly name of package

Service remove_tracking

You can use the service aftership.remove_tracking to remove trackings from Aftership.

Service data attribute Required Type Description
tracking_number True string Tracking number
slug True string Carrier e.g. fedex
This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.