Rename all Steinhart-Hart references to B-param #88

Open
atse wants to merge 1 commits from atse/thermostat:b-parameter into master

The Steinhart-Hart equation was changed in code long ago to the B-parameter equation. Rename references to it and the interface accordingly. The s-h command is now b-p.

The reason the name "B-Parameter" equation was chosen over "Beta-Parameter" was due to its easier searchability.

The Steinhart-Hart equation was changed in code long ago to the B-parameter equation. Rename references to it and the interface accordingly. The `s-h` command is now `b-p`. The reason the name "B-Parameter" equation was chosen over "Beta-Parameter" was due to its [easier](https://duckduckgo.com/?q=B+Parameter+equation&t=ffab&ia=web) [searchability](https://duckduckgo.com/?q=Beta+Parameter+equation&t=ffab&ia=web).
atse added 1 commit 2023-08-28 10:30:50 +08:00
766c37ab96 Rename all Steinhart-Hart references to B-param
The Steinhart-Hart equation was changed in code long ago to the
B-parameter equation. Rename references to it and the interface
accordingly. The `s-h` command is now `b-p`.

The reason the name "B-Parameter" equation was chosen over
"Beta-Parameter" was due to its easier searchability.
sb10q reviewed 2023-08-28 10:33:03 +08:00
README.md Outdated
@ -117,2 +117,2 @@
| `s-h` | Show Steinhart-Hart equation parameters |
| `s-h <0/1> <t0/b/r0> <value>` | Set Steinhart-Hart parameter for a channel |
| `b-p` | Show B-Parameter equation parameters |
| `b-p <0/1> <t0/b/r0> <value>` | Set B-Parameter parameter for a channel |

Parameter much? Maybe "coefficient"?

Parameter much? Maybe "coefficient"?

I did a double-take about that as well since there is a duplication of vocabulary there that didn't exist before.

With Steinhart-Hart it makes sense to call them coefficients, but for the B-Parameter equation they really are just arguments involved in the calculation. Perhaps we should call them "arguments" here?

I did a double-take about that as well since there is a duplication of vocabulary there that didn't exist before. With Steinhart-Hart it makes sense to call them coefficients, but for the B-Parameter equation they really are just arguments involved in the calculation. Perhaps we should call them "arguments" here?

Or simply "Set B-Parameter for a channel".

Or simply "Set B-Parameter for a channel".
atse force-pushed b-parameter from 766c37ab96 to d7462e6791 2024-01-26 17:21:59 +08:00 Compare
This pull request has changes conflicting with the target branch.
  • src/channels.rs
You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.
git checkout -b atse-b-parameter master
git pull b-parameter

Step 2:

Merge the changes and update on Gitea.
git checkout master
git merge --no-ff atse-b-parameter
git push origin master
Sign in to join this conversation.
No reviewers
No Label
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: M-Labs/thermostat#88
There is no content yet.