224 Commits

Author SHA1 Message Date
Adam Mills
f5f5538e82 Clarify requirement for external libraries (#143)
This change clarifies that hass should not be responsible for third party communication details, and that these belong in an external library.
2018-11-07 10:10:35 +01:00
Brad Fitzpatrick
4708b93736 Fix doc typos (#141) 2018-11-03 10:25:44 +01:00
Max Rydahl Andersen
82d2241882 add notice about putting imports inside functions (#137)
* add notice about putting imports inside functions

* Fix based on feedback

* notice on custom_components handling of deps

* Update creating_component_deps_and_reqs.md
2018-11-01 09:41:55 +01:00
Johann Kellerman
3133501503 Update creating_component_generic_discovery.md (#139) 2018-11-01 09:30:55 +01:00
Christian Studer
4b982f9636 Clarifies the order of steps for documentation changes (#136)
* Documentation: Re-arranges order of items

* Readme: Fixes minor typo

* Documentation: Fixes minor grammatical things
2018-10-30 11:49:16 +01:00
Ville Skyttä
3336b07f87 Spelling and grammar fixes 2018-10-29 23:09:38 +02:00
HoppingMonk
d7109b2e78 Add link to add-on security (#135)
This page was created but never added to the introduction list.
2018-10-28 19:26:59 +01:00
Pascal Vizeli
715788d1f5
Update hassio_addon_config.md 2018-10-27 15:33:36 +02:00
Fabian Affolter
61b7870b14
Replace api_password with token (#133)
* Replace api_password with token

* Remove preparation for link
2018-10-25 00:24:45 +02:00
Paulus Schoutsen
e4db9e8c49
Spelling 2018-10-24 19:06:34 +02:00
Paulus Schoutsen
40a7174266 Add extra note about expiration time 2018-10-24 17:49:59 +02:00
Paulus Schoutsen
fb614a9f0b Add docs for signed path 2018-10-24 17:43:58 +02:00
Neil Crosby
62b585644d Use tox-venv to allow tests to run on OSX (#131)
Installing `tox-venv` on OSX allows `tox` tests to be run, per https://community.home-assistant.io/t/installing-hass-on-macos-osx/69292

Alternatively, `tox-venv` _could_ be added directly into the https://github.com/home-assistant/home-assistant/blob/dev/script/bootstrap file, but since nobody outside of OSX developers seem to be having this problem it seemed safer to simply note it in the documentation.

Without installing `tox-venv` the following occurs:

    ERROR: invocation failed (exit code 100), logfile: /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/.tox/py37/log/py37-0.log
    ERROR: actionid: py37
    msg: getenv
    cmdargs: '/Users/neilcrosby/Documents/git-projects.nosync/home-assistant/bin/python3 -m virtualenv --python /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/bin/python3 py37'
    
    /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/lib/python3.7/site-packages/virtualenv.py:1041: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
      import imp
    Already using interpreter /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/bin/python3
    Using base prefix '/usr/local/bin/../Cellar/python/3.7.0/bin/../Frameworks/Python.framework/Versions/3.7'
    New python executable in /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/.tox/py37/bin/python3
    Also creating executable in /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/.tox/py37/bin/python
    ERROR: The executable /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/.tox/py37/bin/python3 is not functioning
    ERROR: It thinks sys.prefix is '/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7' (should be '/Users/neilcrosby/Documents/git-projects.nosync/home-assistant/.tox/py37')
    ERROR: virtualenv is not compatible with this system or executable
    
    ERROR: Error creating virtualenv. Note that some special characters (e.g. ':' and unicode symbols) in paths are not supported by virtualenv. Error details: InvocationError('/Users/neilcrosby/Documents/git-projects.nosync/home-assistant/bin/python3 -m virtualenv --python /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/bin/python3 py37 (see /Users/neilcrosby/Documents/git-projects.nosync/home-assistant/.tox/py37/log/py37-0.log)', 100)
2018-10-23 21:45:34 +02:00
Eduard van Valkenburg
ce18852db3 Made the minimum Python version explicit (#130)
* Made the minimum python version explicit

With a reference to the Debian stable docs.

* moved text down below the overal group of getting started links
2018-10-17 14:41:18 +02:00
Georgi Kirichkov
c9bd65dc24 Prepend rake with bundle exec (#129)
It's highly advisable to run the bundled rake version to prevent errors like `Gem::LoadError: You have already activated rake 12.3.1, but your Gemfile requires rake 10.5.0. Prepending `bundle exec` to your command may solve this.`
2018-10-16 21:00:06 +02:00
Fréderic Kinnaer
b0d075b956 asyncio_index: clearer language (#128) 2018-10-16 16:23:11 +02:00
Pascal Vizeli
331a7df82d
Update hassio_addon_config.md 2018-10-16 12:53:31 +02:00
Ben Lebherz
3ec11e8ffe Fix a few typos/spelling (#127) 2018-10-16 08:26:22 +02:00
Paulus Schoutsen
887f701a76
Add permissions (#118)
* Add permissions

* Mention owner and explain merging
2018-10-15 13:42:17 +02:00
Franck Nijhof
06fc1e7361 Type boolean requires documentation default. (#125) 2018-10-15 13:41:10 +02:00
emontnemery
2b4977754b Update documentation_index.md (#126) 2018-10-15 13:40:45 +02:00
Ville Skyttä
979b2e5b74 Grammar fix 2018-10-14 10:57:02 +03:00
Pascal Vizeli
6f71e2b3b0
Update hassio_addon_security.md 2018-10-12 14:43:57 +02:00
Pascal Vizeli
d758cf2f38
Update hassio_addon_communication.md 2018-10-12 14:43:16 +02:00
Pascal Vizeli
e5b6ea45b7
Update hassio_addon_config.md 2018-10-12 14:42:06 +02:00
William Scanlon
78a97b937d Added water heater doc. (#113)
* Added water heater doc.

* Fixed merge error

* Added states, methods, and operation modes note.
2018-10-11 10:11:56 +02:00
cdce8p
3becc951bf Add rebase warning (#119)
* Added rebase warning

* Update message and position
2018-10-10 22:23:05 +02:00
cdce8p
b09a9ded6c Remove gitignore-example and PR note (#121)
* Remove unused gitignore-template

* Added note to base PR of of dev, not master
2018-10-10 22:21:47 +02:00
Robert Svensson
d9462eb621 Simplify locating how to add dependencies to test environment (#122) 2018-10-10 22:20:09 +02:00
Glenn Waters
0835937954 Update documentation_index.md (#116)
* Update documentation_index.md

Consolidating a bit from README.

* Update documentation_index.md
2018-10-08 12:20:40 +02:00
Fredrik Baberg
442c932a4d Update instructions for Windows (#114)
* Update instructions for Windows.

* Specify a config folder accessible from Windows.
2018-10-08 12:16:31 +02:00
Franck Nijhof
8293f0c4c0
Added float as valid configuration type 2018-10-07 13:08:17 +02:00
WofWca
5aa2e1d83c
Mention Netlify preview, move sentences 2018-10-05 20:21:49 +07:00
Franck Nijhof
644bfa7786
Merge pull request #111 from WofWca/doc-page-spelling
Spelling, wording
2018-10-05 14:52:33 +02:00
WofWca
7203b77f64
Minor improvements 2018-10-05 19:20:59 +07:00
Otto Winter
66dd109a51
Fix linkable_title artifact
Probably an artifact from the home-assistant.io days.
2018-10-04 20:06:44 +02:00
jchasey
80100629d2 Config folder location clarification (#108)
* Config folder location clarification

While this was documented elsewhere in the docs, this is the first thing I was looking for after invoking the dev environment and spent an inordinate amount of time tracking it down.

* link to user docs for clarification

link to user docs to clarify location of config files
2018-10-04 13:43:17 +02:00
Fabian Affolter
d75663199c
Add missing options (#109)
* Add missing options

* Fix link
2018-10-04 09:04:21 +02:00
Pascal Vizeli
a14f7e7cb7
Update hassio_addon_config.md 2018-10-03 17:06:12 +02:00
Franck Nijhof
a02fca3610
Added missing boolean type, updated integer. 2018-10-02 20:52:04 +02:00
WofWca
43f7b46f9d Fix the links, typos and spelling (#100) 2018-10-02 13:45:00 +02:00
Paulus Schoutsen
2f8f31c20e
Remove debugger reference in Windows install 2018-10-02 13:44:05 +02:00
cogneato
c190e72293 Add missing header for generating keys (#101) 2018-10-02 13:43:05 +02:00
Neil Crosby
502a0959f3 Instruct OSX developers to install autoconf (#103)
When running `tox` on OSX as instructed at https://developers.home-assistant.io/docs/en/development_testing.html an error is received stating `error: [Errno 2] No such file or directory: 'autoconf': 'autoconf'`. 

By installing `autoconf` via `homebrew`, this error goes away, and the `tox` tests pass. Telling OSX developers to install `autoconf` at this point in the development environment setup procedure (rather than calling it out on the testing page) seemed to make sense to me.
2018-10-02 13:33:46 +02:00
Fabian Affolter
fbfa4641e0
Update list/map (fixes #104) (#105) 2018-10-02 10:34:48 +02:00
Fabian Affolter
9e84b29dbf
Add internal (#102) 2018-10-01 22:58:24 +02:00
David De Sloovere
53d3ed9fa1 Add virtual environment info to testing (tox) doc (#98)
* Update testing info with virtual environment

Being new to python, pip and virtual environments, I tried running `tox` without activating the virtual environment. This should make it a little bit more clear for newcomers.

* Update development_testing.md

* Update development_testing.md

* Update development_testing.md
2018-10-01 15:28:41 +02:00
Tom Matheussen
e91c3d8274 Fixed IoT class link to blog (#99) 2018-10-01 15:27:24 +02:00
Otto Winter
5f42bd133f Add pressure sensor device class (#97) 2018-10-01 12:32:21 +02:00
Fabian Affolter
7ff1759487
Add additional section (#96) 2018-09-28 01:15:03 +02:00