Skip to content

Commit 063810e

Browse files
latchdevellatchdevel
committed
Initial commit
0 parents  commit 063810e

19 files changed

+1720
-0
lines changed

‎.gitignore

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Compiler outputs
2+
build
3+
4+
# Visual Studio Code
5+
.vscode/
6+
*.code-workspace
7+
.history/
8+
9+
# CMake
10+
CMakeLists.txt.user
11+
CMakeCache.txt
12+
CMakeFiles
13+
CMakeScripts
14+
Testing
15+
Makefile
16+
cmake_install.cmake
17+
install_manifest.txt
18+
compile_commands.json
19+
CTestTestfile.cmake
20+
_deps
21+
22+
# OS generated files
23+
.DS_Store
24+
.DS_Store?
25+
._*
26+
.Spotlight-V100
27+
.Trashes
28+
ehthumbs.db
29+
Thumbs.db
30+
31+
# Prerequisites
32+
*.d
33+
34+
# Compiled Object files
35+
*.slo
36+
*.lo
37+
*.o
38+
*.obj
39+
40+
# Precompiled Headers
41+
*.gch
42+
*.pch
43+
44+
# Compiled Dynamic libraries
45+
*.so
46+
*.dylib
47+
*.dll
48+
49+
# Compiled Static libraries
50+
*.lai
51+
*.la
52+
*.a
53+
*.lib
54+
55+
# Executables
56+
*.exe
57+
*.out
58+
*.app

‎.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "libs/PiCode"]
2+
path = libs/PiCode
3+
url = https://github.com/latchdevel/PiCode
4+
branch = master

‎CMakeLists.txt

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# "picoder"
2+
# Simple standalone command line tool to manage OOK protocols
3+
# supported by "pilight" project, PiCode library based.
4+
#
5+
# Copyright (c) 2021 Jorge Rivera. All right reserved.
6+
# License GNU Lesser General Public License v3.0.
7+
8+
cmake_minimum_required(VERSION 3.1)
9+
10+
project(picoder)
11+
12+
# Set C/C++ Standard
13+
set(CMAKE_C_STANDARD 11)
14+
set(CMAKE_CXX_STANDARD 11)
15+
16+
# Check for git repository information
17+
IF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/.git)
18+
FIND_PACKAGE(Git)
19+
IF(GIT_FOUND)
20+
EXECUTE_PROCESS(
21+
COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
22+
WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
23+
OUTPUT_VARIABLE "BUILD_VERSION"
24+
ERROR_QUIET
25+
OUTPUT_STRIP_TRAILING_WHITESPACE)
26+
SET(BUILD_VERSION "${BUILD_VERSION}" )
27+
MESSAGE( STATUS "Git commit: ${BUILD_VERSION}")
28+
ENDIF(GIT_FOUND)
29+
ENDIF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/.git)
30+
31+
# Force re-run CMake to set BUILD_VERSION on any git commit
32+
set_property(
33+
DIRECTORY
34+
APPEND
35+
PROPERTY CMAKE_CONFIGURE_DEPENDS
36+
.git/index
37+
)
38+
39+
# Set complier identification
40+
SET(BUILD_COMPILER "${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}" )
41+
MESSAGE( STATUS "Compiler: " ${BUILD_COMPILER} )
42+
43+
# Set default build type to "release" set -O3 -DNDEBUG
44+
set(DEFAULT_BUILD_TYPE "release")
45+
46+
# Check if set and valid CMAKE_BUILD_TYPE var
47+
if(NOT CMAKE_BUILD_TYPE)
48+
SET(CMAKE_BUILD_TYPE ${DEFAULT_BUILD_TYPE})
49+
MESSAGE( STATUS "Build type set to default: " ${CMAKE_BUILD_TYPE} )
50+
else()
51+
STRING( TOLOWER "${CMAKE_BUILD_TYPE}" CMAKE_BUILD_TYPE )
52+
if((CMAKE_BUILD_TYPE STREQUAL "debug") OR (CMAKE_BUILD_TYPE STREQUAL "release"))
53+
MESSAGE( STATUS "Build type set to: " ${CMAKE_BUILD_TYPE} )
54+
else()
55+
MESSAGE( FATAL_ERROR "If set CMAKE_BUILD_TYPE it must be Release or Debug")
56+
endif()
57+
endif()
58+
59+
# Setting build type to "debug" add only -g
60+
if(CMAKE_BUILD_TYPE STREQUAL "debug")
61+
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DDEBUG")
62+
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DDEBUG")
63+
endif()
64+
65+
# Set C/C++ flags
66+
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wno-unused-parameter")
67+
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wno-unused-parameter -Wconversion -Woverloaded-virtual")
68+
69+
# Add directory for PiCode library
70+
add_subdirectory( libs/PiCode/ )
71+
72+
# Set source directory for picoder sources
73+
AUX_SOURCE_DIRECTORY( src/ SRC )
74+
75+
# Add picoder as executable
76+
add_executable( ${PROJECT_NAME} ${SRC} )
77+
78+
# Add include directory to use #include <PiCode.h>
79+
target_include_directories( ${PROJECT_NAME} PRIVATE libs/PiCode/src/ )
80+
81+
# Add PiCode static library (libpicode.a) to link picoder executable
82+
target_link_libraries( ${PROJECT_NAME} PUBLIC picode )
83+
84+
# If git info available adds to picoder executable as environment var
85+
if(DEFINED BUILD_VERSION)
86+
target_compile_definitions( ${PROJECT_NAME} PRIVATE BUILD_VERSION=${BUILD_VERSION} )
87+
endif(DEFINED BUILD_VERSION)
88+
89+
# Add complier identification to picoder executable as environment var
90+
target_compile_definitions( ${PROJECT_NAME} PRIVATE BUILD_COMPILER=${BUILD_COMPILER} )
91+
92+
MESSAGE(STATUS "Source directory: ${CMAKE_SOURCE_DIR}")
93+
MESSAGE(STATUS "Install prefix: ${CMAKE_INSTALL_PREFIX}")
94+
95+
install(TARGETS picoder DESTINATION bin)
96+
97+
add_custom_target( uninstall
98+
"${CMAKE_COMMAND}" -P "${CMAKE_SOURCE_DIR}/uninstall.cmake"
99+
)

‎LICENSE.md

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

0 commit comments

Comments
 (0)