Skip to content

Commit

Permalink
Docu improvements (#162)
Browse files Browse the repository at this point in the history
* Remove leftover

* Don't explain the repo structure 5 times

* Add schematics overview

* Prettify logo SVG

* Give logo background color

* Fix layer order

* Give the lightning some color

* Apply liniting to SVG
  • Loading branch information
dmohns authored Jan 23, 2024
1 parent db7f17c commit 93bdc00
Show file tree
Hide file tree
Showing 10 changed files with 345 additions and 213 deletions.
77 changes: 0 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,88 +61,11 @@ Due to varying tolerances of used components, it is vital to perform a calibrati
This is used to correct any errors due to varying tolerances.
Further details including source code, schematics, and manufacturing files can be found in the EnAccess github repository

## Repository structure

### documentations

The documentation folder contain all information as related to manufacturing the smart energy meter, information such as Api documentation, rationale behind design, calibration report, trouble shooting manual, bill of material, datasheet for all components used.

### Firmware codes

The firware code folder contain the firmware code written in C++ on Arduino platform, the folder also contain the library files used in the code.

### Meter hardware design

The meter hardware design folder contain the Kicad design file, gerber manufacturing file, exterior casing manufacturing files, design images.

### Web software demo video

This folder contain the web demo video to guide a developer developer on the functionality of the web software.

### Web software

This folder contain the web software codes used.
The link to the web demo is: <https://paygotesting.000webhostapp.com>

## Quick look at the schematic

### Microcontroller voltage regulation stage

<img
width="716"
alt="Screen Shot 2022-10-20 at 3 24 06 PM"
src="https://user-images.githubusercontent.com/99180312/196975773-aa3449d5-49b1-4783-9f9f-867684f050d3.png">

The voltage regulation stage contains the `7805IC` to regulate the voltage from the SMPS power supply to 5V as this is the safe voltage level to power the microcontroller, also this stage contains the `LM350IC` to regulate the SMPS power sully to 4V to power the GSM module.

#### Analog front end chip connection

The analog front end chip (AFE) is a metering IC suitable for a class1 and class2 accuracy meter and fit for use according to the relevant metering standard as specified by IEC.
It is used in this design to measure power, voltage, current, power factor etc..

<img
width="648"
alt="Screen Shot 2022-10-20 at 3 22 27 PM"
src="https://user-images.githubusercontent.com/99180312/196975383-3d3c08d3-d81d-4f1d-9e23-7cb3d03cdbc5.png">

#### SMPS power supply stage

The SMPS stage converts the AC input voltage supplied into the meter to 12V DC to power the internal electronics circuit.

![image](https://user-images.githubusercontent.com/99180312/195889282-7c816822-8ac1-4781-a278-c50e86c304fc.png)

#### Microcontroller/Cicada GSM Module/LED/ LCD\n RS232/RTC/Relay/Keypad/Buzzer

The master of this stage is the microcontroller(STM32f103ccu8) popularly known as bluepill, it fethes outputted meter values from the AFE chip via the USART communication interface, it also communicate with the webpage via the Cicada GSM module and sends neccesary meter parameters to the RS232 port, this stage also interface with other hardware pheripherials such as keypad, buzzer, magnetic latching relay, LED, LCD.

<img
width="521"
alt="Screen Shot 2022-10-20 at 3 22 12 PM"
src="https://user-images.githubusercontent.com/99180312/196975441-1a624a4a-a18b-4802-9d05-9fbae708dcd0.png">

# How to get started

This document summarizes the manufacturing guide to enable a skilled person to manufacture the smart energy meter.
The foldered is structured as highlighted below including informations available in each folder.

## Repository Layout

### Documentations

The documentation folder is sub-divided into different folder containing relating documents as named in the folder title.

### Firmware code

The firmware code folder contain the Firmware code and all library used in the smart meter design.

### Meter hardware design (layout)

The meter hardware design folder contain all relating files as relating the manufacturing meter hardware such as design images, exterior casing design file, PCB CAD design file, GERBER file.

### Web software (layout)

The meter web software folder contain the web software code, from the front end, backend, images, styling file e.t.c.

## Web Software

The web software is split into different parts as highlighted below.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/hardware/microcontroller-miscs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/hardware/smps-power-supply-stage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions docs/hardware/schematic_overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
sidebar_position: 0
---

# Schematic Overview

## Microcontroller voltage regulation stage

![microcontroller-voltage-regulation-stage](../assets/hardware/microcontroller-voltage-regulation-stage.png)

The voltage regulation stage contains the `7805IC` to regulate the voltage from the SMPS power supply to 5V as this is the safe voltage level to power the microcontroller, also this stage contains the `LM350IC` to regulate the SMPS power sully to 4V to power the GSM module.

## Analog front end chip connection

The analog front end chip (AFE) is a metering IC suitable for a class1 and class2 accuracy meter and fit for use according to the relevant metering standard as specified by IEC.
It is used in this design to measure power, voltage, current, power factor etc..

![analog-frontend-chip-connection](../assets/hardware/analog-frontend-chip-connection.png)

## SMPS power supply stage

The SMPS stage converts the AC input voltage supplied into the meter to 12V DC to power the internal electronics circuit.

![smps-power-supply-stage](../assets/hardware/smps-power-supply-stage.png)

## Microcontroller/Cicada GSM Module/LED/ LCD\n RS232/RTC/Relay/Keypad/Buzzer

The master of this stage is the microcontroller(STM32f103ccu8) popularly known as bluepill, it fethes outputted meter values from the AFE chip via the USART communication interface, it also communicate with the webpage via the Cicada GSM module and sends neccesary meter parameters to the RS232 port, this stage also interface with other hardware pheripherials such as keypad, buzzer, magnetic latching relay, LED, LCD.

![microcontroller-miscs](../assets/hardware/microcontroller-miscs.png)
114 changes: 113 additions & 1 deletion docs_website/static/img/about.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
75 changes: 74 additions & 1 deletion docs_website/static/img/get-started.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 93bdc00

Please sign in to comment.