Commit 7837f090 authored by Theot Mickael's avatar Theot Mickael
Browse files

Updated readme.md

parent 2027d8c9
# Zoom emergency exit button
Just press the big red button to quit zoom metting
\ No newline at end of file
Just press the big red button to quit zoom metting !
![cover_image](./img/cover.jpg)
## Hardware required
* 1 Push button
* 1 Arduino Micro board (or Leonardo)
* 2 Wires
## Schematic (so simple)
![schematic](./img/schematic.png)
## Upload the code
This project has been developed under VSCode/PlatformIO.
Simply use "Import Arduino Project" to build and upload the code to the board.
Select the board you are using (Arduino Micro or Leonardo) and find the zoom-emergency-exit-button folder you have downloaded and unziped
![Pio_image](./img/pio_screenshot.png)
Plug the Arduino to your computer, Compile & Upload !
![Pio_upload](./img/how_to_upload.png)
## Troubleshooting
If the compiler can't find the `Keybord.h` file, check the external librairies path under `platformio.ini` file.
**Note 1** You might need to install the Arduino IDE to have access to this lib...
**Note 2** If you want to change the code and pressed letters, be careful, the library uses the QWERTY template.
**Inspired by this project** : https://www.instructables.com/Easy-Zoom-Quit-Button/
\ No newline at end of file
This directory is intended for project header files.
A header file is a file containing C declarations and macro definitions
to be shared between several project source files. You request the use of a
header file in your project source file (C, C++, etc) located in `src` folder
by including it, with the C preprocessing directive `#include'.
```src/main.c
#include "header.h"
int main (void)
{
...
}
```
Including a header file produces the same results as copying the header file
into each source file that needs it. Such copying would be time-consuming
and error-prone. With a header file, the related declarations appear
in only one place. If they need to be changed, they can be changed in one
place, and programs that include the header file will automatically use the
new version when next recompiled. The header file eliminates the labor of
finding and changing all the copies as well as the risk that a failure to
find one copy will result in inconsistencies within a program.
In C, the usual convention is to give header files names that end with `.h'.
It is most portable to use only letters, digits, dashes, and underscores in
header file names, and at most one dot.
Read more about using header files in official GCC documentation:
* Include Syntax
* Include Operation
* Once-Only Headers
* Computed Includes
https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
This directory is intended for project specific (private) libraries.
PlatformIO will compile them to static libraries and link into executable file.
The source code of each library should be placed in a an own separate directory
("lib/your_library_name/[here are source files]").
For example, see a structure of the following two libraries `Foo` and `Bar`:
|--lib
| |
| |--Bar
| | |--docs
| | |--examples
| | |--src
| | |- Bar.c
| | |- Bar.h
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
| |
| |--Foo
| | |- Foo.c
| | |- Foo.h
| |
| |- README --> THIS FILE
|
|- platformio.ini
|--src
|- main.c
and a contents of `src/main.c`:
```
#include <Foo.h>
#include <Bar.h>
int main (void)
{
...
}
```
PlatformIO Library Dependency Finder will find automatically dependent
libraries scanning project source files.
More information about PlatformIO Library Dependency Finder
- https://docs.platformio.org/page/librarymanager/ldf.html
; PlatformIO Project Configuration File
;
; Build options: build flags, source filter
; Upload options: custom upload port, speed and extra flags
; Library options: dependencies, extra library storages
; Advanced options: extra scripting
;
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html
[env:micro]
platform = atmelavr
board = micro
framework = arduino
lib_extra_dirs = /snap/arduino/50/libraries
/*
For the Arduino Leonardo and Micro.
Sends a key sequence when a button is pressed.
The circuit:
- pushbutton attached to pin 2 and GND
created 24 Oct 2011
modified 27 Mar 2012
by Tom Igoe
modified 11 Nov 2013
by Scott Fitzgerald
modified 07 Mar 2021
by Mickaël Theot
This example code is in the public domain.
http://www.arduino.cc/en/Tutorial/KeyboardMessage
*/
#include "Keyboard.h"
const int buttonPin = 2; // input pin for pushbutton
int previousButtonState = LOW; // for checking the state of a pushButton
void setup() {
// make the pushButton pin an input:
pinMode(buttonPin, INPUT_PULLUP);
// initialize control over the keyboard:
Keyboard.begin();
}
void loop() {
// read the pushbutton:
int buttonState = digitalRead(buttonPin);
// if the button state has changed,
if ((buttonState != previousButtonState) && (buttonState == LOW)) {
Keyboard.press(KEY_LEFT_ALT);
Keyboard.write(97);//"q letter"
Keyboard.release(KEY_LEFT_ALT);
delay(100);
Keyboard.press(KEY_TAB);
Keyboard.release(KEY_TAB);
delay(100);
Keyboard.press(KEY_RETURN);
Keyboard.release(KEY_RETURN);
delay(500);
}
// save the current button state for comparison next time:
previousButtonState = buttonState;
}
This directory is intended for PlatformIO Unit Testing and project tests.
Unit Testing is a software testing method by which individual units of
source code, sets of one or more MCU program modules together with associated
control data, usage procedures, and operating procedures, are tested to
determine whether they are fit for use. Unit testing finds problems early
in the development cycle.
More information about PlatformIO Unit Testing:
- https://docs.platformio.org/page/plus/unit-testing.html
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment