Skip to content

Commit

Permalink
Initial update
Browse files Browse the repository at this point in the history
  • Loading branch information
akkoyun committed Dec 25, 2023
1 parent 26431eb commit 6812363
Show file tree
Hide file tree
Showing 16 changed files with 1,584 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: akkoyun
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']%
40 changes: 40 additions & 0 deletions .github/workflows/workflow.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# This is a basic workflow to help you get started with Actions

name: PlatformIO

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
branches: [Master]

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:

# This workflow contains a single job called "build"
build:

# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:

- uses: actions/checkout@v2
with:
submodules: "true"

- name: Set up Python
uses: actions/setup-python@v1

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install platformio
# It is important to first install the libraries before compiling, since otherwise compilation might fail to find the just-installed libraries
- name: Install platformIO libraries
run: pio lib install

- name: Run PlatformIO
run: platformio run
57 changes: 57 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
### macOS ###
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

### macOS Patch ###
# iCloud generated files
*.icloud

### PlatformIO ###
.pioenvs
.piolibdeps
.clang_complete
.gcc-flags.json
.pio

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets

# Local History for Visual Studio Code
.history/

# Built Visual Studio Code Extensions
*.vsix

### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide
30 changes: 30 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"cSpell.enableFiletypes": [
"avr"
],
"cSpell.words": [
"Akkoyun",
"atmelavr",
"atmelmegaavr",
"FOTA",
"Günce",
"ICCID",
"IMBAL",
"IMEI",
"IRMS",
"IRMSA",
"IRMSB",
"IRMSC",
"Mehmet",
"UART",
"VAFUND",
"VARHA",
"VARHB",
"VARHC",
"VRMS",
"VRMSA",
"VRMSB",
"VRMSC",
"VSAG"
]
}
1 change: 1 addition & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @akkoyun
24 changes: 24 additions & 0 deletions Docs/I2C_Scanner.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ I2C Device Explorer │
├───────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┤
│ │ 0x_0 │ 0x_1 │ 0x_2 │ 0x_3 │ 0x_4 │ 0x_5 │ 0x_6 │ 0x_7 │ 0x_8 │ 0x_9 │ 0x_a │ 0x_b │ 0x_c │ 0x_d │ 0x_e │ 0x_f │
├───────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ 0x0_ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├───────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ 0x1_ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├───────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ 0x2_ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├───────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ 0x3_ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├───────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ 0x4_ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├───────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ 0x5_ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├───────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ 0x6_ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├───────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
│ 0x7_ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
├───────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┤
│ Total connected device : Current Mux Channel [0-8] : │
└───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
github.com/akkoyun
Empty file added Docs/README.md
Empty file.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Mehmet Günce Akkoyun

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# VT100 Console Library <sup>V1.6</sup>

![GitHub release (latest by date)](https://img.shields.io/github/v/release/akkoyun/Console) ![arduino-library-badge](https://www.ardu-badge.com/badge/Console.svg?) ![Visits Badge](https://badges.pufler.dev/visits/akkoyun/Console) ![GitHub stars](https://img.shields.io/github/stars/akkoyun/Console?style=flat&logo=github) ![Updated Badge](https://badges.pufler.dev/updated/akkoyun/Console) ![PlatformIO Registry](https://badges.registry.platformio.org/packages/akkoyun/library/Console.svg)

---

## Abstract

Virtual terminal sequences are control character sequences that can control cursor movement, color/font mode, and other operations when written to the output stream. Sequences may also be received on the input stream in response to an output stream query information sequence or as an encoding of user input when the appropriate mode is set.

Arduino based VT100 comparable serial console library.
</br>

<center><img src="https://github.com/akkoyun/Console/raw/Master/Docs/Demo.png" width="600"></center></br>

---

[![Support me](https://img.shields.io/badge/Support-PATREON-GREEN.svg)](https://www.patreon.com/bePatron?u=62967889) ![Twitter Follow](https://img.shields.io/twitter/follow/gunceakkoyun?style=social) ![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCIguQGdaBT1GnnVMz5qAZ2Q?style=social) ![Repos Badge](https://badges.pufler.dev/repos/akkoyun) [![E-Mail](https://img.shields.io/badge/E_Mail-Mehmet_Gunce_Akkoyun-blue.svg)](mailto:[email protected]) ![GitHub](https://img.shields.io/github/license/akkoyun/Statistical)
20 changes: 20 additions & 0 deletions examples/I2C_Scanner/I2C_Scanner.ino
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Include Libraries
#include <Console.h>

// Define Object
I2C_Scanner_Console Terminal(Serial);

void setup() {

// Start Serial Stream
Serial.begin(115200);

// Start Terminal
Terminal.Begin();

}

void loop() {


}
22 changes: 22 additions & 0 deletions examples/PowerStat/PowerStat.ino
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// Include Libraries
#include <Console.h>

// Define Object
PowerStat_Console Terminal(Serial);

void setup() {

// Start Serial Stream
Serial.begin(115200);

// Start Terminal
Terminal.Begin();

}

void loop() {

// Print Terminal Text
Terminal.Text(2, 13, _Console_RED_, String(millis()));

}
64 changes: 64 additions & 0 deletions keywords.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
#######################################
# Syntax Coloring Map For Console
#######################################

#######################################
# Datatype (KEYWORD1)
#######################################

Console KEYWORD1
PowerStat_Console KEYWORD1
I2C_Scanner_Console KEYWORD1
TH_Meter_Console KEYWORD1
Voltmeter_Console KEYWORD1
MAX78630_Console KEYWORD1
Analog_Pressure_Console KEYWORD1

#######################################
# Methods and Functions (KEYWORD2)
#######################################

Begin KEYWORD2
Clear KEYWORD2
Cursor KEYWORD2
Box KEYWORD2
Dot KEYWORD2
Bracket KEYWORD2
Divider KEYWORD2
Text_Color KEYWORD2
Background_Color KEYWORD2
Text_Format KEYWORD2
Set_Cursor KEYWORD2
Beep KEYWORD2
Text KEYWORD2
OK KEYWORD2
AT_Command KEYWORD2

#######################################
# Constants (LITERAL1)
#######################################

_Console LITERAL1
_Console_BLACK_ LITERAL1
_Console_RED_ LITERAL1
_Console_GREEN_ LITERAL1
_Console_YELLOW_ LITERAL1
_Console_BLUE_ LITERAL1
_Console_MAGENTA_ LITERAL1
_Console_CYAN_ LITERAL1
_Console_WHITE_ LITERAL1
_Console_GRAY_ LITERAL1
_Console_RST_ LITERAL1
_Console_BRIGHT_ LITERAL1
_Console_DIM_ LITERAL1
_Console_UNDERSCORE_ LITERAL1
_Console_BLINK_ LITERAL1
_Console_REVERSE_ LITERAL1
_Console_HIDDEN_ LITERAL1
_Console_LINE_AFTER_CURSOR_ LITERAL1
_Console_LINE_TO_CURSOR_ LITERAL1
_Console_LINE_ LITERAL1
_Console_SCREEN_ LITERAL1
_Console_ALL_ LITERAL1
HORIZONTAL LITERAL1
VERTICAL LITERAL1
41 changes: 41 additions & 0 deletions library.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"name": "Console",
"version": "1.6.6",
"keywords": "Console, Serial, VT100, UART, Color, Terminal",
"description": "Virtual terminal sequences are control character sequences that can control cursor movement, color/font mode, and other operations when written to the output stream. Sequences may also be received on the input stream in response to an output stream query information sequence or as an encoding of user input when the appropriate mode is set. Arduino based VT100 comparable serial console library.",
"authors":
{
"name": "Mehmet Günce Akkoyun",
"email": "[email protected]",
"url": "https://github.com/akkoyun"
},
"license": "MIT",
"frameworks": "arduino",
"headers": "Console.h",
"platforms":
[
"atmelavr",
"atmelmegaavr"
],
"repository":
{
"type": "git",
"url": "https://github.com/akkoyun/Console.git"
},
"examples": [
{
"name": "PowerStat",
"base": "examples/PowerStat",
"files": [
"PowerStat.ino"
]
},
{
"name": "I2C_Scanner",
"base": "examples/I2C_Scanner",
"files": [
"I2C_Scanner.ino"
]
}
]
}
11 changes: 11 additions & 0 deletions library.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name=Console
version=1.6.6
author=Gunce Akkoyun <[email protected]>
maintainer=Gunce Akkoyun <[email protected]>
sentence=Arduino based VT100 comparable serial console library.
paragraph=Virtual terminal sequences are control character sequences that can control cursor movement, color/font mode, and other operations when written to the output stream. Sequences may also be received on the input stream in response to an output stream query information sequence or as an encoding of user input when the appropriate mode is set.
category=Communication
url=https://github.com/akkoyun/Console
architectures=*
includes=Console.h
types=Arduino
Loading

0 comments on commit 6812363

Please sign in to comment.