https://github.com/thecaptaincraken/ohmscript
OhmScript is a interpreted scripting language to help you calculate the equivalent resistance of multiple resistors.
https://github.com/thecaptaincraken/ohmscript
Last synced: 24 days ago
JSON representation
OhmScript is a interpreted scripting language to help you calculate the equivalent resistance of multiple resistors.
- Host: GitHub
- URL: https://github.com/thecaptaincraken/ohmscript
- Owner: TheCaptainCraken
- License: mit
- Created: 2024-11-27T19:50:27.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-12-28T10:36:05.000Z (7 months ago)
- Last Synced: 2025-04-02T11:49:40.858Z (3 months ago)
- Language: Rust
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OhmScript
>OhmScript is a interpreted scripting language to help you calculate the equivalent resistance of multiple resistors.
## Syntax
This is an example OhmScript:
```ohmscript
R1 = 1k
R2 = 220
R3 = 300
? = //(R1,R2, R3)
R4 = 100k
? = //(R2, ->(R3, R4), R3)
```
*This prints `112.62798634812287` and `126.76266707517904`*
There are just a few operators in OhmScript:
- `=`: this is the assign operator. It binds a name to a value.
- `?`: this is a special name, everything assigned to it gets evaluated and printed.
- `//`: this is the parallel operator. `//(R1, R2)` is equivalent to $\frac{R_1 \cdot R_2}{R_1 + R_2}$.
- `->`: this is the series operator. `->(R1, R2)` is equivalent to $R_1 + R_2$.
In OhmScript, instead of writing `A = 225000`, you can use the `k` shorthand: `A=225k`.
## How to use it
>[!important]
>You must have the rust language installed on your system
Using OhmScript is as simple as:
```bash
git clone https://github.com/TheCaptainCraken/ohmscript
cd ohmscript
cargo run
```
At this point you should see the prompt:
```plain
Ohm >
```
Just start typing!
## Future additions
These are features I'll implement if I get to work on this again.
- [ ] Better error handling/reporting
- [ ] Voltage / current divider.
- [ ] Other modifiers (we just have k).
- [ ] Support for capacitors and inductors.
- [ ] Allow the user to specify precision.
- [ ] Symbolic resolution.