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-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Grammar fixes, server_sent_events.md (#1255)

Browse Source 
Reworded a few sentences for clarity, fixed some grammar, added a link to httpie, and put more detail into some of the running instructions.
This commit is contained in:
jack 2016-10-17 12:24:41 -04:00 committed by Fabian Affolter
parent 7586adf828
commit 4f7481e2d0
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
source/developers/server_sent_events.markdown
View File

@ -22,7 +22,7 @@ $ curl -X GET -H "x-ha-access: YOUR_PASSWORD" \
-H "Content-Type: application/json" http://localhost:8123/api/stream -H "Content-Type: application/json" http://localhost:8123/api/stream
``` ```
For more comfort put the HTML snippet below in a file `sse.html` in your `www` folder of your Home Assistant configuration directory (`.homeassistant`) You can create a convenient view for this by creating an HTML file (`sse.html`) in the `www` folder of your Home Assistant configuration directory (`.homeassistant`). Paste this snippet into the file:
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
@ -44,7 +44,7 @@ Visit [http://localhost:8123/local/sse.html](http://localhost:8123/local/sse.htm
## {% linkable_title Examples %} ## {% linkable_title Examples %}
A simplest way to consume server-sent events is `httpie`. A simple way to consume server-sent events is to use a command-line http client like [httpie][https://httpie.org/]. Installation info is on the site (if you use Homebrew, it's `brew install httpie`). Once installed, run this snippet from your terminal:
```bash ```bash
$ http --stream http://localhost:8123/api/stream x-ha-access:YOUR_PASSWORD content-type:application/json $ http --stream http://localhost:8123/api/stream x-ha-access:YOUR_PASSWORD content-type:application/json
@ -52,17 +52,17 @@ $ http --stream http://localhost:8123/api/stream x-ha-access:YOUR_PASSWORD conte
### {% linkable_title Website %} ### {% linkable_title Website %}
The [home-assistant-sse](https://github.com/fabaff/home-assistant-sse) repository contains an more advanced example. The [home-assistant-sse](https://github.com/fabaff/home-assistant-sse) repository contains a more advanced example.
### {% linkable_title Python %} ### {% linkable_title Python %}
If you want test the server-sent events without creating a website then the Python module [`sseclient` ](https://pypi.python.org/pypi/sseclient/) can help. Install it first: If you want to test the server-sent events without creating a website, the Python module [`sseclient` ](https://pypi.python.org/pypi/sseclient/) can help. To install (assuming Python and pip3 are already installed):
```bash ```bash
$ pip3 install sseclient $ pip3 install sseclient
``` ```
The simplest script to consume the SSE looks like the following snipplet. The simplest script to consume the SSE in Python looks like this:
```python ```python
from sseclient import SSEClient from sseclient import SSEClient