README.md · 上海市虹口区青少年活动中心/Morse-Pjct（摩尔斯码）

# **Morse Project**
> - Sender and Receiver  
> - **Version** 2.2

**This is a project on Arduino, aiming to perform morse code style wireless communication(Li-Fi? maybe).  
Current project have been partly completed, but bugs may be still existing, you can mail me(thewater2016@qq.com) to report if any happens, that would help a lot, thanks.XD**
***
**More About:**  
> - It's a disappointing news that this module **would** make program stuck(delay()), that means you probably need threads to deal with it.  
> - You actually don't need the .ino file. ~~Like you don't need an empty *WORD* file.~~  
> - The "morse.h" works on "ports.h", which means you should **not** separate them into different folders. ~~Don't make the love story filled with sadness.~~
***
### Current Progress:
> - Basic functions finished.  
> - Adding analog ports support.
***
### Current Classes & Functions
#### In *"ports.h"*:
- namespace Ports **: Namespace of this whole header.**
  - DIPort **: The class for Digital Input port.**  
    - DIPort(int port, bool reversed = false) **: Class constructor, will set target port pin mode. *port*: Set the port index of this instance. *reversed*: Set whether the input of this instance should be inverted.**
    - void setPort(int port) **: Set a port for this instance, will set target port pin mode. *port*: The port index.**
    - void setReverse(bool reversed) **: Set whether the input of this instance should be inverted. *reversed*: Yes or no.**
    - bool get(void) **: Return current value of this instance.**
  - DOPort **: The class for Digital Output port.**
    - DOPort(int port, bool reversed = false) **: Class constructor, will set target port pin mode. *port*: Set the port index of this instance. *reversed*: Set whether the output of this instance should be inverted.**
    - void setPort(int port) **: Set a port for this instance, will set target port pin mode. *port* The port index.**
    - void setReverse(bool reversed) **: Set whether the output of this instance should be inverted. *reversed*: Yes or no.**
    - void set(bool Hol) **: Set the current output of this instance. *Hol*: HIGH or LOW, please use true or false instead.**
  - AIPort **: The class for Analog Input port.**
    - AIPort(int port, bool reversed = false) **: Class constructor, will set target port pin mode. *port*: Set the port index of this instance. *reversed*: Set whether the input of this instance should be inverted.**
    - void setPort(int port) **: Set a port for this instance, will set target port pin mode. *port*: The port index.**
    - void setReverse(bool reversed) **: Set whether the input of this instance should be inverted. *reversed*: Yes or no.**
    - int get(void) **: Return current value of this instance.**
  - AOPort **: The class for Analog Output port.**
    - AOPort(int port, bool reversed = false) **: Class constructor, will set target port pin mode. *port*: Set the port index of this instance. *reversed*: Set whether the output of this instance should be inverted.**
    - void setPort(int port) **: Set a port for this instance, will set target port pin mode. *port*: The port index.**
    - void setReverse(bool reversed) **: Set whether the output of this instance should be inverted. *reversed*: Yes or no.**
#### In *"morse.h"*
- #define **: Mostly not necessary for users.**
  - #define M_TIMEUNIT 200 **: Morse code timeunit(in msec), you can define it before including *morse.h* to cover with the length you prefer.**
  - #define M (M_TIMEUNIT/5.0f) **: The length for detecting whether the input is static.**
  - #define M_ M_TIMEUNIT **: The length for short and space between signal.**
  - #define M__ (M_TIMEUNIT\*3) **: The length for long.**
  - #define M___ (M_TIMEUNIT\*7) **: The length for blank between characters.**
  - #define M_0 **~** #define M_9 **: The RawCode of '0' ~ '9'.**
  - #define M_A **~** #define M_Z **: The RawCode of 'A' ~ 'Z'.**
  - #define M__A **~** #define M__R **: The RawCode of punctuations.**
- namespace Morse **: Namespace of this whole header.**
  - namespace Digital **: Based on Digital ports.**
    - MorseSender **: The class for a Digital Output port, to work as a Morse code sender.**
      - MorseSender(int port, bool reversed = false) **: Class constructor, will set target port pin mode. *port*: Set the port index of this instance. *reversed*: Set whether the output of this instance should be inverted.**
      - void setPort(int port) **: Set a port for this instance, will set target port pin mode. *port*: The port index.**
      - void setReverse(bool reversed) **: Set whether the output of this instance should be inverted. *reversed*: Yes or no.**
      - void set(bool Hol) **: Set the current output of this instance. *Hol*: HIGH or LOW, please use true or false instead.**
      - void set(int length) **: Set the current output of this instance to high, and low after some time. *length*: The length of time(in msec).**
      - void send(int rawCode) **: Send a set of signal. *rawCode*: The RawCode of the set.**
      - void send(char ch) **: Send a character or punctuation if it has a Morse code. *ch*: ASC II number of the character or punctuation.**
      - void send(const char* str) **: Send a string, the characters or punctuations which has no Morse code would be seen as space. *str*: The pointer points the first element of the string.**
      - operator<< **The same as the functions *send()*.**
    - MorseRecver **: The class for a Digital Input port, to work as a Morse code receiver.**
      - MorseRecver(int port, bool reversed = false) **: Class constructor, will set target port pin mode. *port*: Set the port index of this instance. *reversed*: Set whether the input of this instance should be inverted.**
      - void setPort(int port) **: Set a port for this instance, will set target port pin mode. *port*: The port index.**
      - void setReverse(bool reversed) **: Set whether the input of this instance should be inverted. *reversed*: Yes or no.**
      - bool get(void) **: Return current value of this instance.**
      - void get(int\* buffer) **: Get the received RawCode. *buffer*: The pointer points where to put the RawCode.**
      - void get(int& buffer) **: Get the received RawCode. *buffer*: Where to put the RawCode.**
      - char recv(void) **: Return the received character or punctuation.**
      - void recv(char& buffer) **: Get the received character or punctuation. *buffer*: Where to put the character or punctuation.**
      - void recv(char\* buffer) **: Get the received character or punctuation. *buffer*: The pointer points where to put the character or punctuation.**
      - void recv(char\* buffer, int maxLength) **: Get the received characters or punctuations. *buffer*: The pointer points the start of where to put the characters or punctuations. *maxLength*: The length the function should put once.**
      - operator>> **The same as the functions *recv()*.**
  - namespace Analog **: Based on Analog ports.**
    - MorseSender **: The class for a Analog Output port, to work as a Morse code sender.**
      - MorseSender(int port, bool reversed = false, int defaultLvl = 255) **: Class constructor, will set target port pin mode. *port*: Set the port index of this instance. *reversed*: Set whether the output of this instance should be inverted. *defaultLvl*: Set the analog value which will be used as 'on'.**
      - void setPort(int port) **: Set a port for this instance, will set target port pin mode. *port*: The port index.**
      - void setReverse(bool reversed) **: Set whether the output of this instance should be inverted. *reversed*: Yes or no.**
      - void set(bool Hol) **: Set the current output of this instance. *Hol*: The value user set or 0, please use true or false.**
      - void set(int length) **: Set the current output of this instance to the value user set, and 0 after some time. *length*: The length of time(in msec).**
      - void send(int rawCode) **: Send a set of signal. *rawCode*: The RawCode of the set.**
      - void send(char ch) **: Send a character or punctuation if it has a Morse code. *ch*: ASC II number of the character or punctuation.**
      - void send(const char* str) **: Send a string, the characters or punctuations which has no Morse code would be seen as space. *str*: The pointer points the first element of the string.**
      - operator<< **The same as the functions *send()*.**
      - void setLvl(int Lvl) **: Set the analog value used for output. *Lvl*: The value.**
    - MorseRecver **: The class for a Analog Input port, to work as a Morse code receiver.**
      - MorseRecver(int port, bool reversed = false, int defaultLvl = 511) **: Class constructor, will set target port pin mode. *port*: Set the port index of this instance. *reversed*: Set whether the input of this instance should be inverted. *defaultLvl*: Set the analog value which will be recognized as 'on'.**
      - void setPort(int port) **: Set a port for this instance, will set target port pin mode. *port*: The port index.**
      - void setReverse(bool reversed) **: Set whether the input of this instance should be inverted. *reversed*: Yes or no.**
      - bool get(void) **: Return current value(over the value user set or not) of this instance.**
      - void get(int\* buffer) **: Get the received RawCode. *buffer*: The pointer points where to put the RawCode.**
      - void get(int& buffer) **: Get the received RawCode. *buffer*: Where to put the RawCode.**
      - char recv(void) **: Return the received character or punctuation.**
      - void recv(char& buffer) **: Get the received character or punctuation. *buffer*: Where to put the character or punctuation.**
      - void recv(char\* buffer) **: Get the received character or punctuation. *buffer*: The pointer points where to put the character or punctuation.**
      - void recv(char\* buffer, int maxLength) **: Get the received characters or punctuations. *buffer*: The pointer points the start of where to put the characters or punctuations. *maxLength*: The length the function should put once.**
      - operator>> **The same as the functions *recv()*.**
      - void setLvl(int Lvl) **: Set the analog value used for input. *Lvl*: The value.**

上海市虹口区青少年活动中心/Morse-Pjct（摩尔斯码）

简介

发行版

贡献者

近期动态

上海市虹口区青少年活动中心/Morse-Pjct（摩尔斯码） .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

上海市虹口区青少年活动中心/Morse-Pjct（摩尔斯码）