algosup / 2023-2024-project-4-sportshield-team-5

BSD 3-Clause "New" or "Revised" License
3 stars 0 forks source link

Technical : Confusing sentences [2024/03/26] #16

Closed TechXplorerFR closed 7 months ago

TechXplorerFR commented 7 months ago

Description

Some elements are missing/wrong in the technical (/documents/technical-specifications/technical-specification.md) and should be updated as soon as possible.

Severity

  1. Critical (Severe impact)

Version

a4ad752

Expected Correction

Line 88

Blurry explanations

Current: When the cable is wrapped and the box is in a locked state, the device is looking for any physical disturbances. If any movement or vibration of the box is detected as a possible theft, it turns on a strong alarm, more or less loud according to the level of disturbance (intensity and duration of the movement). At the same time, it sends a warning notification to the owner by a dedicated smartphone application, using the internet network.

Expected: When the cable is wrapped and the lock is in a locked state, the device is sensitive to any disturbance. Suppose a movement or vibration of the box is detected as a possible theft. It turns on an alarm, with a sound intensity proportional to the motion detected (intensity and duration of the movement). At the same time, it sends a warning notification to the owner by a dedicated smartphone application, using the 2G network.

Line 140

Confusing sentence

Current: To dive into the electronic circuits of the PCB, there is the [PCB circuit schematic](data/SportShield-Electronics-diagram.png) provided by the company. However, this scematic is not up to date. The most important is the absence of the Q5 MOSFET used to cut the battery to other components using the control pin D9.

Expected: To dive into the electronic circuits of the PCB, there is the [PCB circuit schematic](data/SportShield-Electronics-diagram.png) provided by the company. However, this schematic is not up to date. The most important point is the absence of the Q5 MOSFET. This component is principally used to cut power supply to other components using the control pin D9.

Line 172

Confusing sentence

Current: On the IDE, there is a some buttons on the top like that :

Expected: On the IDE, there are some buttons on the top organized as follows:

Other Details

No response