home-assistant.io/source/_components/sensor.uscis.markdown
2018-09-03 08:54:50 +02:00

42 lines
1.1 KiB
Markdown

---
layout: page
title: USCIS Sensor
description: "Instructions on how to set up USCIS within Home Assistant."
date: 2018-03-21 08:00
sidebar: true
comments: false
sharing: true
footer: true
logo: uscis.png
ha_category: Sensor
ha_release: 0.68
ha_iot_class: "Cloud Polling"
---
The `uscis` sensor component allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do)
## {% linkable_title Configuration %}
To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
sensor:
- platform: uscis
case_id: YOUR_CASE_NUMBER
name: OPTIONAL_NAME
```
{% configuration %}
name:
description: Name of the sensor in Home Assistant.
required: false
default: USCIS
type: string
case_id:
description: Case/receipt number used to get the case details from USCIS web client.
required: true
type: string
{% endconfiguration %}
All the data will be fetch from [USCIS](https://egov.uscis.gov/casestatus/mycasestatus.do).