Skip to content

Commit

Permalink
Merge pull request #114 from jpbaril/patch-1
Browse files Browse the repository at this point in the history
Update CODES_SYNTAX.md
  • Loading branch information
litinoveweedle authored Aug 22, 2024
2 parents 803ef27 + 0ac4500 commit 0e10f2c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/CODES_SYNTAX.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
- [You can ask for help at SmartIR Climate (Home Assistant Community)](https://community.home-assistant.io/t/smartir-control-your-climate-tv-and-fan-devices-via-ir-rf-controllers/).
- If you think something is missing or wrong in the docs and you would like to submit PR with docs amendments you are welcome.

## Device code JSON file
## Device codes JSON file

If you decide to modify or create your own device file you need to do it in the `custom_code/[climate|fan|media_player|/` directory. Any changes inside `codes` directory will be lost upon SmartIR HACS update!
If you decide to modify or create your own device file you need to do it in the `custom_codes/[climate|fan|media_player|/` directory. Any changes inside `codes` directory will be lost upon SmartIR HACS update!

- If you need to modify existing file from the `code` directory please copy it into `custom_codes` first.
- If you need to modify existing file from the `codes` directory please copy it into `custom_codes` first.
- If you need to create new device file please choose free for digit file name (not used by existing json file int the `codes/your_class` directory) and create json file with given name in the `custom_codes/your_class`

Each different class (Climate, Fan, Media Player) device file has common part and then class specific part. Please take look to some existing files as examples. It is very easy to make error in JSON file structure when editing. Use any available JSON format checker to validate it after editing - for example [JSON Lint](https://jsonlint.com/)
Expand Down

0 comments on commit 0e10f2c

Please sign in to comment.