Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typo fixes #155

Merged
merged 1 commit into from
Jul 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/devices/JQJCY01YM.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
|-|-|
|Brand|Xiaomi|
|Model|Formaldehyde detector|
|Short Description|Homeywell formaldehyde monitor|
|Short Description|Honeywell formaldehyde monitor|
|Communication|BLE broadcast|
|Frequency|2.4Ghz|
|Power source|2 AA|
Expand Down
6 changes: 3 additions & 3 deletions docs/participate/adding-decoders.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ Each device must provide a `brand`, `model`, `model_id`, `condition`, and `prope
- `model_id` = model id number of the device.

### Condition
`condition` is a JSON array, which must contain as the first parameter, the data source to test for the condtion. Valid inputs are:
`condition` is a JSON array, which must contain as the first parameter, the data source to test for the condition. Valid inputs are:
- "servicedata"
- "manufacturerdata"
- "name"
- "uuid"

The second parameter is variable. If required, further qualification can be made by setting a conditional data length in the case of "servicedata" or "manufacturerdata" as the first condition. This is an operator in the form of `">" , ">=" , "=" , "<" , "<="` followed by the third parameter being a numeric value that specifies the length of the data to accept. If no data length is defined the second paramater must indicate how the data should be tested. Valid inputs are:
The second parameter is variable. If required, further qualification can be made by setting a conditional data length in the case of "servicedata" or "manufacturerdata" as the first condition. This is an operator in the form of `">" , ">=" , "=" , "<" , "<="` followed by the third parameter being a numeric value that specifies the length of the data to accept. If no data length is defined the second parameter must indicate how the data should be tested. Valid inputs are:
- "contain" tests if the specified value (see below) exists the data source
- "index" tests if the specified value exists at the index location (see below) in the data source

Expand All @@ -58,7 +58,7 @@ Examples:

The third parameter (fifth if data length is specified) can be either the index value or the data value to find. If the second (fourth if data length specified) parameter is `contain`, the next parameter should be the value to look for in the data source. If the second (fourth if data length specified) parameter is `index`, the next parameter should be the location in the data source to look for the value.

`condition` can have multiple conditions chanined together using "|" and "&" between them.
`condition` can have multiple conditions chained together using "|" and "&" between them.
For example: `"condition":["servicedata", "index", 0, "0804", "|", "servicedata", "index", 0, "8804"]`
This will match if the service data at index 0 is "0804" `OR` "8804".

Expand Down
2 changes: 1 addition & 1 deletion docs/participate/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ agree to follow the code of conduct below
[code of conduct](https://github.com/theengs/decoder/blob/master/CODE_OF_CONDUCT.md)

[code style guide](https://google.github.io/styleguide/cppguide.html#Formatting)
So as to format automaticaly your document you have to add the "clang-Format" extension to VSCode, once done, you can format the code by doing a right click into the code file window and clicking "Format document".
So as to format automatically your document you have to add the "clang-Format" extension to VSCode, once done, you can format the code by doing a right click into the code file window and clicking "Format document".

Fork the [development branch](https://github.com/theengs/decoder/tree/development), then clone the repo

Expand Down
2 changes: 1 addition & 1 deletion docs/participate/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ If you like the project and/or used it please consider supporting it! It can be
* Helping others in the [community](https://github.com/theengs/decoder/discussions)
* [Contribute](development) to the [code](https://github.com/theengs/decoder) or the documentation,
* Buy devices, boards or parts from the [OpenMQTTGateway compatible web site](https://compatible.openmqttgateway.com), the devices and parts linked use affiliated links,
* Donate or sponsor the project [developpers](https://github.com/theengs/decoder/graphs/contributors)
* Donate or sponsor the project [developers](https://github.com/theengs/decoder/graphs/contributors)
* Make a video or a blog article about what you have done with [TheengsDecoder](https://github.com/theengs/decoder) and share it.