1. Principles and practices

Assignment :

Principles and Practices

Plan and sketch a potential final project.
Project Management

Idea for my final project 🫣

my current idea for a final project is a funny camera. projet name TELEMAK, A pretty 3D printed design to allow, children play with it ,when it is let on their near. Telemak will have 2 axis rotate control, led, proximity sensor, speaker. for this purpose, i want to use a xio esp32 C3 for wifi and bluetooth communication

I don’t want to be big brothers, but in my life i have lost many think became i don’t have surveillance camera, in my home, in my office, and even in my farms....don’t laught 😂. I’ve been robbed and i took on me to realise this project. I could have bought, but I want to master it and maybe do something cheaper and more accessible. the other point is also the software side and access to personal data. the fun aspect for children is just an idea to make them friendly and given to the camera for possible home assistant functionality.

Sketch of my final project 😇

This is my sketch

I have used AI to have some representative 3D image of my telemak project

Materials

Qty	Description	Price	Link	Notes
2	xio ESP32	22.00 $	http://amazon.com/test	Order many
1	PI camera	22.00 $	http://amazon.com/test
2	Nema stepper Motor	22.00 $	http://amazon.com/test
1	speaker	22.00 $	http://amazon.com/test
1	led	22.00 $	http://amazon.com/test
1	proximity sensor	22.00 $	http://amazon.com/test

2. project management

how to create my website ?🤔

To build our website, we will be using MkDocs, a static site generator. The site’s source files will be written in Markdown and configured using a single YAML configuration file.

FIRST STEP : installing mkdocs on windows PC💻

we first need to make sure that we have the latest version of Python installed. choose the latest version.

we’ll need to check the “Add python.exe to path” box before proceeding with the installation, as illustrated in the image below.

Once Python has been installed, we can now install MkDocs. Open the command prompt on our computer and enter the following command: /pip install mkdocs/

SECOND STEP : Use of an MkDocs model

To develop our website, we have adopted the model accessible via the following link : Mkdocs model

Once you have downloaded the template in file format (.zip), extract it into the directory of your choice. To make local changes to the template, you need certain basic elements.

To use the model we downloaded (Material for MkDocs theme), we need to install it in phyton. To do this we need to enter the command line pip install mkdocs-material in our command prompt

then install the mkdocs-git-revision-date-localized-plugin. To do this we need to enter the pip install mkdocs-git-revision-date-localized-plugin command line in our command prompt.

Now that we have everything we need, we can launch our site locally. To do this we need to open our command prompt and enter the command cd “path to your project”. Then we enter the following command mkdocs serve to start the MkDocs server locally.

THIRD STEP : Modifications to our site

We’re going to use VScode to modify our site. We’re going to open our site’s repository with VScode.

On windows 11 right click and choose show other options and click on open with code

We can now click on mkdocs.yml and make our modifications to the form (colours and text…)

By clicking on the other folders we can modify the background of our site

To develop our web pages, we will be using Markdown. This is a lightweight mark-up language that allows formatting elements to be added to plain text documents. Files use the *.md extension. Here are some examples of the basic Markdown syntax that we will use to edit our web pages.

GITLAB USING📚

FIST STEP : Instaling GIT

To install GIT, click here and choose the windows option.

SECOND STEP : Cloning the gitlab repository

To carry out this operation we need to :

Create an empty folder in the location of your choice“avoid long paths”.

Open GitBash on our PC and type the command line : cd "path of the folder created below"
Initialize a new Git repository : git init
Add our Git username and define our email address: git config --global user.name "our_username"
Let’s set up the download e-mail address : git config --global user.email "our_email@exemple.com
Generate our SSH key : ssh-keygen -t rsa -C "our_email"
Let’s take a look at our keygen : cat ~/.ssh/id_rsa.pub
Copy our SSH key to display it in our Gitbash

Open GitLab > Account > Preferences > SSH Keys > paste in the contents of the file you have created

Let’s open the folder on our computer where we’ll be working. Right-click > Git Bash here

use the command : git clone <repository path to clone>.
To obtain the path: open the Git repository to be cloned > Clone :

THIRD STEP : Download the repository online

To download the online repository, we need :

Add the new files we’ve added to gitlab : git add index.html to upload file by file or git add . to upload all the files at once
Name our update, so we know what we’ve changed with this push : git commit -m ‘change we did’
Download repository : git push

We’ve finished our site and it’s now online. We’ll have to wait three minutes before we can see the results online.

Useful links

Last update: May 12, 2024