Skip to content

Commit be5d67a

Browse files
committed
Fix typos and improve clarity in README.md
1 parent 9c5fe1e commit be5d67a

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

readme.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@
4040
- [Battery](#battery)
4141
- [Type __\*__](#type-)
4242
- [Voltage __\*__](#voltage-)
43-
- [Chemistrie __\*__](#chemistrie-)
43+
- [Chemistry __\*__](#chemistry-)
4444
- [Capacity __\*__](#capacity-)
4545
- [charge efficiency \[%\]](#charge-efficiency-)
46-
- [Minimun SOC \[%\]](#minimun-soc-)
47-
- [Replacment date](#replacment-date)
46+
- [Minimum SOC \[%\]](#minimum-soc-)
47+
- [Replacement date](#replacement-date)
4848
- [Manufacturer](#manufacturer)
4949
- [Battery full detection](#battery-full-detection)
5050
- [Voltage when full \[V\] __\*__](#voltage-when-full-v-)
@@ -66,15 +66,15 @@ Here are some key details about the INA226:
6666
- Shunt Voltage Range (for current measurement): ±82mV
6767
- The INA226 can handle shunt voltages as low as 60mV and as high as 82mV, depending on the current and the shunt resistor used
6868

69-
The INA226 should be connected to the shunt so that charges going into the battery are positive and those coming out of the battery are negtive.
69+
The INA226 should be connected to the shunt so that charges going into the battery are positive and those coming out of the battery are negative.
7070

7171
The system communicates via the NMEA 2000 protocol, sending temperature values and alarms as NMEA 2000 messages over an NMEA bus. Configuration is done through a web interface, and real-time values can be viewed on a website. Additionally, there's a link on the configuration page for convenient firmware updates.
7272

7373
## Disclaimer
7474
| | |
7575
|-|-----------------|
76-
| <img src="img/warning.png" width="100" alt="warning"> | Allways use a fuse in the + line from the battery to the sensor!! |
77-
| <img src="img/warning.png" width="100" alt="warning"> | Be careful when using metal tools in the vicinity of batteries. Dropping a metal tool onto a battery might cause a short circuit and possibly an explosion.
76+
| <img src="img/warning.png" width="100" alt="warning"> | Always use a fuse in the + line from the battery to the sensor!! |
77+
| <img src="img/warning.png" width="100" alt="warning"> | Be careful when using metal tools in the vicinity of batteries. Dropping a metal tool onto a battery might cause a short circuit and possibly an explosion. |
7878

7979
## Schema
8080
<img src="sch/schema.png" width="600" alt="schema">
@@ -89,19 +89,23 @@ The following PGN's will be send
8989

9090
## Librarys
9191

92-
The Software has been created using Visual Studio with the addon Visual Micro. In order to build it you als need some libraries.
92+
The Software has been created using Visual Studio with the addon Visual Micro. In order to build it you also need some libraries.
9393

9494
- Wire
9595
- [OneWire (2.3.7)](https://github.com/PaulStoffregen/OneWire)
96-
- [DallasTemperature(3.9.0)](https://github.com/milesburton/Arduino-Temperature-Control-Library)
96+
- [DallasTemperature (3.9.0)](https://github.com/milesburton/Arduino-Temperature-Control-Library)
9797
- [NMEA2000](https://github.com/ttlappalainen/NMEA2000)
98-
- [NMEA200_ESP32](https://github.com/ttlappalainen/NMEA2000_esp32)
99-
- [AsyncTCP (3.2.6) __"__](https://github.com/mathieucarbou/AsyncTCP)
98+
- [NMEA2000_ESP32](https://github.com/ttlappalainen/NMEA2000_esp32)
99+
- [AsyncTCP (3.2.6) __*__](https://github.com/mathieucarbou/AsyncTCP)
100100
- [ESPAsyncWebServer (3.3.12) __*__](https://github.com/mathieucarbou/ESPAsyncWebServer)
101-
- [Webserial (2.0.7) __*__](https://github.com/ayushsharma82/WebSerial)
101+
- [WebSerial (2.0.7) __*__](https://github.com/ayushsharma82/WebSerial)
102102
- [IotWebConf](https://github.com/minou65/IotWebConf)
103103
- [IotWebConfAsync (1.0.2) __*__](https://github.com/minou65/IotWebConfAsync)
104104
- [IotWebRoot](https://github.com/minou65/IotWebRoot)
105+
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson)
106+
- [Preferences](https://github.com/espressif/arduino-esp32/tree/master/libraries/Preferences) (ESP32 built-in)
107+
- [WiFi](https://github.com/espressif/arduino-esp32/tree/master/libraries/WiFi) (ESP32 built-in)
108+
- [Update](https://github.com/espressif/arduino-esp32/tree/master/libraries/Update) (ESP32 built-in)
105109

106110
__*__ new version and/or new repo
107111

@@ -192,7 +196,7 @@ If you don’t plan to connect the sensor to a WiFi network, you don’t need to
192196

193197
### NEMA configuration
194198
#### Instance
195-
This should be unique at least on one device. May be best to have it unique over all devices sending this PGN. A total of 5 instances are occupied by the device. Starting with the number set here. __*__
199+
This should be unique at least on one device. May be best to have it unique over all devices sending this PGN. A total of 5 instances are occupied by the device, starting with the number set here. __*__
196200

197201
#### SID
198202
Sequence identifier. In most cases you can use just 255 for SID. The sequence identifier field is used to tie different PGNs data together to same sampling or calculation time.
@@ -219,7 +223,7 @@ Assuming a voltage of 75 mV at nominal current, the resulting resistance in ohms
219223

220224

221225
#### Expected max current [A] __*__
222-
maximum current that may flow through the shut
226+
Maximum current that may flow through the shunt
223227

224228
#### Voltage calibration factor
225229
Use a multimeter to measure the voltage on the battery. The measured voltage divided by the voltage displayed by the battery monitor gives the factor that you enter here.
@@ -249,7 +253,7 @@ one of the following
249253

250254
Please note that the sensor is built for a maximum voltage of 40V without any special measures!
251255

252-
#### Chemistrie __*__
256+
#### Chemistry __*__
253257
- lead acid
254258
- LiIon
255259
- NiCad
@@ -271,10 +275,10 @@ gas (highly explosive!). The energy stored in the plates can be retrieved during
271275
Gassing can easily be observed in flooded batteries. Please note that the ‘oxygen only’ end of the charge phase of sealed (VRLA) gel
272276
and AGM batteries also results in a reduced charge efficiency.
273277

274-
#### Minimun SOC [%]
278+
#### Minimum SOC [%]
275279
The minimum SoC is the lowest level of charge that a battery can safely operate at without damaging its cells or reducing its capacity. It is usually expressed as a percentage of the maximum charge. For example, if a battery has a minimum SoC of 10%, it means that it should not be discharged below 10% of its full capacity.
276280

277-
#### Replacment date
281+
#### Replacement date
278282
The replacement date is the date when the battery was replaced with a new one. It is only for documentation
279283

280284
#### Manufacturer
@@ -341,11 +345,11 @@ When in AP mode, the default IP address is 192.168.4.1
341345
To update the firmware, navigate to the Configuration page and click on the Firmware Update link. Follow the on-screen instructions to complete the update process.
342346

343347
## Blinking codes
344-
Prevoius chapters were mentioned blinking patterns, now here is a table summarize the menaning of the blink codes.
348+
Previous chapters mentioned blinking patterns, now here is a table summarizing the meaning of the blink codes.
345349

346350
| Blinking Pattern | Meaning |
347351
| --- | --- |
348-
| Rapid blinking <\br>(mostly on, interrupted by short off periods) | Entered Access Point mode. This means the device creates its own WiFi network. You can connect to the device with your smartphone or WiFi capable computer. |
352+
| Rapid blinking <br>(mostly on, interrupted by short off periods) | Entered Access Point mode. This means the device creates its own WiFi network. You can connect to the device with your smartphone or WiFi capable computer. |
349353
| Alternating on/off blinking | Trying to connect to the configured WiFi network. |
350354
| Mostly off with occasional short flash | The device is online. |
351355
| Mostly off with occasional long flash | The device is in offline mode |

0 commit comments

Comments
 (0)