Skip to content

Commit

Permalink
Merge commit '855933d10fe88fee52399930f80fa0362c2180a5' into develop
Browse files Browse the repository at this point in the history
* commit '855933d10fe88fee52399930f80fa0362c2180a5':
  Added WifiStation.connect() to Basic_rboot sample (SmingHub#1215)
  Appvoyer CI will use the updated choco packages. (SmingHub#1210)
  Added dynamic recalculation of image offsets to prever rom overlapping. (SmingHub#1208)
  Added Gitter Notifications. (SmingHub#1205)
  Better Arduino compatability: Changed to order of the Wire.begin and Wire.pins parameters to (SmingHub#1193)
  Small fixes before the final 3.3.0 (SmingHub#1203)
  Preparation for the final 3.3.0 release. (SmingHub#1202)
  Added example demonstrating Js and CSS combining ... (SmingHub#1200)
  Fixed WebSocket sample HTML page (SmingHub#1201)
  Feature/auto deployment on release (SmingHub#1198)
  • Loading branch information
johndoe8967 committed Aug 5, 2017
2 parents d730cca + 855933d commit a93547a
Show file tree
Hide file tree
Showing 53 changed files with 465 additions and 861 deletions.
30 changes: 26 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ language: cpp
env:
global:
- SDK_BUILD=258

- secure: Db9Cnv+oOmmQMm6aIf3H5VYHaas04uGOtvJMsq7NW05oyDVGCgV5FayjFPVzNHHgv85em1u1CPqX3p7eHWLSKMjARcEpLavXM31HW0RPxvserSpXI7f49EBi6ENgCPre4NGMWpdJgvIhmAfcEMwyLUBqRDmfH4KqqE8V5ZbhvacCbaD2cEOsPDjbkpA66VYp3srTmVUR4cC0ehUdg7odxVOWHaJbA068jJjwz/ggbYMkVljcFkjVHtZAIiZDN1vBGRWGwTjM4TMXwJmw07WumBwhZw6Qm7OShGfBTyg5/6Obqk1QZ///6BQCUD+bGhLlfEleEB48YJXwLD96HXgUwu/wZ7xWStQCWW5GQRPgXaufwZcc1TySJxaDeMhk90cIbUsjXGhmhV+rpM/5PMZTvpTOJbKrz2oY2qqFEZJGEYGoH24LHp4yPpAvQCmqjeLcQj/JiHeL9nKUy+mC3yOPLR/DOTa7t7zN8vuKqm0G0Af3DXXuum2kkzBgHFCNiiLedF2/7BVe/nAbOJLpuQwfVVOqpxIpTzKg05oPmjSsFPp4u03Yso3Kc6ulJQ354mYmnZD34jah5FaWo8YkGCmAGLIaqpcV62LCTSDK58ZMpEU1fy3jANlmktDQlaCUvniUo+c0mqmlstRpzGathb4u1nNHdgB/rjzDx64ug2MmllI=

matrix:
include:
- os: linux
Expand All @@ -18,16 +19,24 @@ addons:
apt:
sources:
- ubuntu-toolchain-r-test
- sourceline: 'ppa:libreoffice/libreoffice-4-2'
packages:
- bsdtar
- doxygen
- doxygen-doc
- doxygen-latex
- doxygen-gui
- graphviz

install:
- if [ "$SDK_VERSION" != "2.0.0" ] && [ "$TRAVIS_OS_NAME" == "osx" ]; then export SDK_FILE_NAME="esp-alt-sdk-v${SDK_VERSION}.${SDK_BUILD}-macos-x86_64.zip"; fi
- if [ "$SDK_VERSION" != "2.0.0" ] && [ "$TRAVIS_OS_NAME" == "linux" ]; then export SDK_FILE_NAME="esp-alt-sdk-v${SDK_VERSION}.${SDK_BUILD}-linux-x86_64.tar.gz"; fi
- mkdir -p $TRAVIS_BUILD_DIR/opt/esp-alt-sdk
- if [ "$SDK_VERSION" != "2.0.0" ]; then wget https://bintray.com/artifact/download/kireevco/generic/${SDK_FILE_NAME}; fi
- if [ "$SDK_VERSION" != "2.0.0" ]; then bsdtar -xf ${SDK_FILE_NAME} -C $TRAVIS_BUILD_DIR/opt/esp-alt-sdk; fi
- if [ "$SDK_VERSION" == "2.0.0" ] && [ "$TRAVIS_OS_NAME" == "linux" ]; then wget https://github.com/nodemcu/nodemcu-firmware/raw/master/tools/esp-open-sdk.tar.xz; tar -Jxvf esp-open-sdk.tar.xz; ln -s `pwd`/esp-open-sdk/xtensa-lx106-elf $TRAVIS_BUILD_DIR/opt/esp-alt-sdk/. ; fi
- if [ "$SDK_VERSION" == "2.0.0" ] && [ "$TRAVIS_OS_NAME" == "linux" ]; then wget http://bbs.espressif.com/download/file.php?id=1690 -O sdk.zip; unzip sdk.zip; ln -s `pwd`/ESP8266_NONOS_SDK/ $TRAVIS_BUILD_DIR/opt/esp-alt-sdk/sdk; fi
- if [ "$SDK_VERSION" == "2.0.0" ] && [ "$TRAVIS_OS_NAME" == "linux" ]; then wget http://bbs.espressif.com/download/file.php?id=1690 -O sdk.zip; unzip sdk.zip; ln -s `pwd`/ESP8266_NONOS_SDK/ $TRAVIS_BUILD_DIR/opt/esp-alt-sdk/sdk; export DEPLOY='true'; fi

script:
- export CHANGED_FILES=`git diff --diff-filter=AMD HEAD HEAD^ --name-only`
- export CHANGED_PROJECTS=`for i in $CHANGED_FILES; do echo "$i" | grep '^samples/' | cut -d'/' -f2; done | uniq`
Expand All @@ -47,5 +56,18 @@ script:
- make clean samples-clean
- make ENABLE_CUSTOM_HEAP=1
- make Basic_Blink ENABLE_CUSTOM_HEAP=1
- make clean samples-clean
- make ENABLE_CUSTOM_LWIP=1; make samples ENABLE_CUSTOM_LWIP=1

deploy:
provider: script
script: sh $TRAVIS_BUILD_DIR/.travis/deploy.sh $TRAVIS_TAG
skip_cleanup: true
on:
tags: true
condition: $DEPLOY == true

notifications:
webhooks:
urls:
- https://webhooks.gitter.im/e/c1a5e8bc97d3794a0417
on_success: always # options: [always|never|change] default: always
on_failure: always # options: [always|never|change] default: always
29 changes: 29 additions & 0 deletions .travis/deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#!/bin/bash
set -e # exit with nonzero exit code if anything fails

TAG=$1
if [ -z $TAG ]; then
echo "Usage:\n\t$0 <tag>\n";
exit 1;
fi


# Get information about the release
# TODO: ...

# Update documentation
cd $SMING_HOME
make docs
cd ..

git fetch origin gh-pages:gh-pages
git checkout gh-pages

DOCS_DIR=$SMING_HOME/../api

rm -rf $DOCS_DIR
cp -r $SMING_HOME/../docs/api/sming/ $DOCS_DIR
git add -A $DOCS_DIR
git commit -m "Updated the API docs to version $TAG." || 1

git push https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages
6 changes: 4 additions & 2 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ SDK = Software Development Kit
n/a = The selected SDK is not available on that OS

## Latest Stable Release
- [Sming V3.2.0](https://github.com/SmingHub/Sming/releases/tag/3.2.0)
- [Sming V3.3.0](https://github.com/SmingHub/Sming/releases/tag/3.3.0)

## Getting started
- [Windows](https://github.com/SmingHub/Sming/wiki/Windows-Quickstart)
Expand All @@ -64,8 +64,9 @@ n/a = The selected SDK is not available on that OS
- Custom PWM: (default: ON) If you don't want to use the [open PWM implementation](https://github.com/StefanBruens/ESP8266_new_pwm) then compile your application with `ENABLE_CUSTOM_PWM=0`. There is no need to recompile the Sming library.
- Custom serial baud rate: (default: OFF) The default serial baud rate is 115200. If you want to change it to a higher baud rate you can recompile Sming and your application changing the `COM_SPEED_SERIAL` directive. For example `COM_SPEED_SERIAL=921600`.
- Custom heap allocation: (default: OFF) If your application is experiencing heap fragmentation then you can try the [umm_malloc](https://github.com/rhempel/umm_malloc) heap allocation. To enable it compile Sming with `ENABLE_CUSTOM_HEAP=1`. In order to use it in your sample/application make sure to compile the sample with `ENABLE_CUSTOM_HEAP=1`. **Do not enable custom heap allocation and -mforce-l32 compiler flag together**.
- Debug information log level and format: There are four debug levels: debug=3, info=2, warn=1, error=0. Using `DEBUG_VERBOSE_LEVEL` you can set the desired level (0-3). For example `DEBUG_VERBOSE_LEVEL=2` will show only info messages and above. Another make directive is `DEBUG_PRINT_FILENAME_AND_LINE=1` which enables printing the filename and line number of every debug line. This will require extra space on flash. Note: you can compile the Sming library with a set of debug directives and your project with another settings, this way you can control debugging sepparately for sming and your application code.
- Debug information log level and format: There are four debug levels: debug=3, info=2, warn=1, error=0. Using `DEBUG_VERBOSE_LEVEL` you can set the desired level (0-3). For example `DEBUG_VERBOSE_LEVEL=2` will show only info messages and above. Another make directive is `DEBUG_PRINT_FILENAME_AND_LINE=1` which enables printing the filename and line number of every debug line. This will require extra space on flash. Note: you can compile the Sming library with a set of debug directives and your project with another settings, this way you can control debugging separately for Sming and your application code.
- Debug information for custom LWIP: If you use custom LWIP (see above) some debug information will be printed for critical errors and situations. You can enable debug information printing altogether using `ENABLE_LWIPDEBUG=1`. To increase debugging for certain areas you can modify debug options in `third-party/esp-open-lwip/include/lwipopts.h`.
- Interactive debugging on the device: (default: OFF) In order to be able to debug live directly on the ESP8266 microcontroller you should re-compile your application and the Sming library with `ENABLE_GDB=1` directive. See [Basic_Debug](https://github.com/SmingHub/Sming/tree/develop/samples/Basic_Debug) sample for more details.
- CommandExecutor feature: (default: ON) This feature enables execution of certain commands by registering token handlers for text received via serial, websocket or telnet connection. If this feature is not used additional RAM/Flash can be obtained by setting `ENABLE_CMD_EXECUTOR=0`. This will save ~1KB RAM and ~3KB of flash memory.

</p></details>
Expand All @@ -74,6 +75,7 @@ n/a = The selected SDK is not available on that OS
See the getting started page for your respective operating system.

You can find more information about compilation and flashing process by reading esp8266.com forum discussion thread.
Official ESP8266 documentation can be found in the [Espressif website](https://espressif.com/en/support/download/documents?keys=&field_type_tid%5B%5D=14).

## Examples
More information at **[Wiki Examples](https://github.com/SmingHub/Sming/wiki/examples)** page.
Expand Down
4 changes: 3 additions & 1 deletion Sming/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,9 @@ TARGET = app
CUSTOM_TARGETS ?=

# which modules (subdirectories) of the project to include in compiling
MODULES = system system/helpers Wiring appinit $(shell find SmingCore -type d) $(filter %/, $(wildcard Services/*/)) $(filter %/, $(wildcard Libraries/*/))
MODULES = system system/helpers Wiring appinit \
$(sort $(dir $(wildcard SmingCore/*/ SmingCore/*/*/ SmingCore/*/*/*/))) \
$(filter %/, $(wildcard Services/*/)) $(filter %/, $(wildcard Libraries/*/))
EXTRA_INCDIR = include system/include Wiring Libraries SmingCore $(SDK_BASE)/../include

# Place a file that should exist in a submodule that is fetched separately
Expand Down
42 changes: 33 additions & 9 deletions Sming/Makefile-project.mk
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ SPIFFY ?= $(SMING_HOME)/spiffy/spiffy

#ESPTOOL2 config to generate rBootLESS images
IMAGE_MAIN ?= 0x00000.bin
IMAGE_SDK ?= 0x0a000.bin # The name must match the starting address of the irom0 section
# in the LD file ($SMING_HOME/compiler/ld/standalone.rom.ld).
# To calculate the value do the following: x = irom0_0_seg.org - 0x40200000
# Example: 0x4020a000 - 0x40200000 = 0x0a000
IMAGE_SDK_OFFSET = $(shell printf '0x%x\n' $$(( ($$($(GET_FILESIZE) $(FW_BASE)/$(IMAGE_MAIN)) + 0x1000 + $(basename $(IMAGE_MAIN))) & (0xFFFFF000) )) )
IMAGE_SDK ?= $(IMAGE_SDK_OFFSET).bin
IROM0_ORG0 = $(shell printf '0x%x\n' $$(( 0x40200000 + $(IMAGE_SDK_OFFSET))) )

INIT_BIN_ADDR = 0x7c000
BLANK_BIN_ADDR = 0x4b000

Expand All @@ -55,6 +55,9 @@ ESPTOOL2_SECTS ?= .text .data .rodata
ESPTOOL2_MAIN_ARGS ?= -quiet -bin -boot0
ESPTOOL2_SDK_ARGS ?= -quiet -lib

# SED path
SED ?= sed

## ESP_HOME sets the path where ESP tools and SDK are located.
## Windows:
# ESP_HOME = c:/Espressif
Expand Down Expand Up @@ -259,6 +262,8 @@ LDFLAGS = -nostdlib -u call_user_start -Wl,-static -Wl,--gc-sections -Wl,-Map=$

# linker script used for the above linkier step
LD_PATH = $(SMING_HOME)/compiler/ld
PROJECT_LD_PATH=ld

LD_SCRIPT = standalone.rom.ld

ifeq ($(SPI_SPEED), 26)
Expand Down Expand Up @@ -367,9 +372,28 @@ all: $(USER_LIBDIR)/lib$(LIBSMING).a checkdirs $(TARGET_OUT) $(SPIFF_BIN_OUT) $(

spiff_update: spiff_clean $(SPIFF_BIN_OUT)

$(TARGET_OUT): $(APP_AR)
$(vecho) "LD $@"
$(Q) $(LD) -L$(USER_LIBDIR) -L$(SDK_LIBDIR) -L$(LD_PATH) -T$(LD_SCRIPT) $(LDFLAGS) -Wl,--start-group $(LIBS) $(APP_AR) -Wl,--end-group -o $@
$(PROJECT_LD_PATH)/$(LD_SCRIPT):
$(Q) mkdir -p $(PROJECT_LD_PATH)
$(Q) cp $(LD_PATH)/$(LD_SCRIPT) $@

$(FW_BASE)/$(IMAGE_MAIN): $(APP_AR)
# Pass 1: Generate rom0 to be able to check its size
$(Q) $(LD) -L$(USER_LIBDIR) -L$(SDK_LIBDIR) -L$(LD_PATH) -T$(LD_SCRIPT) $(LDFLAGS) -Wl,--start-group $(LIBS) $(APP_AR) -Wl,--end-group -o $(TARGET_OUT).tmp

$(Q) $(STRIP) $(TARGET_OUT).tmp

$(Q) $(ESPTOOL2) $(ESPTOOL2_MAIN_ARGS) $(TARGET_OUT).tmp $@ $(ESPTOOL2_SECTS)

$(Q) rm $(TARGET_OUT).tmp

$(TARGET_OUT): $(FW_BASE)/$(IMAGE_MAIN) $(PROJECT_LD_PATH)/$(LD_SCRIPT)
$(vecho) "LD $@"

# Readjust linker
$(Q) $(SED) -r "s/(^\s*irom0_0_seg *: *).*/\\1org = $(IROM0_ORG0), len = \(1M - $(IMAGE_SDK_OFFSET)\)/" $(LD_PATH)/$(LD_SCRIPT) > $(PROJECT_LD_PATH)/$(LD_SCRIPT)

# Pass 2: Generate roms with correct offsets
$(Q) $(LD) -L$(USER_LIBDIR) -L$(SDK_LIBDIR) -L$(PROJECT_LD_PATH) -L$(LD_PATH) -T$(LD_SCRIPT) $(LDFLAGS) -Wl,--start-group $(LIBS) $(APP_AR) -Wl,--end-group -o $@

$(Q) $(STRIP) $@

Expand Down Expand Up @@ -454,9 +478,9 @@ flash: all
$(vecho) "Killing Terminal to free $(COM_PORT)"
-$(Q) $(KILL_TERM)
ifeq ($(DISABLE_SPIFFS), 1)
$(ESPTOOL) -p $(COM_PORT) -b $(COM_SPEED_ESPTOOL) write_flash $(flashimageoptions) $(basename $(IMAGE_MAIN)) $(FW_BASE)/$(IMAGE_MAIN) $(basename $(IMAGE_SDK)) $(FW_BASE)/$(IMAGE_SDK)
$(ESPTOOL) -p $(COM_PORT) -b $(COM_SPEED_ESPTOOL) write_flash $(flashimageoptions) $(basename $(IMAGE_MAIN)) $(FW_BASE)/$(IMAGE_MAIN) $(IMAGE_SDK_OFFSET) $(FW_BASE)/$(IMAGE_SDK)
else
$(ESPTOOL) -p $(COM_PORT) -b $(COM_SPEED_ESPTOOL) write_flash $(flashimageoptions) $(basename $(IMAGE_MAIN)) $(FW_BASE)/$(IMAGE_MAIN) $(basename $(IMAGE_SDK)) $(FW_BASE)/$(IMAGE_SDK) $(SPIFF_START_OFFSET) $(SPIFF_BIN_OUT)
$(ESPTOOL) -p $(COM_PORT) -b $(COM_SPEED_ESPTOOL) write_flash $(flashimageoptions) $(basename $(IMAGE_MAIN)) $(FW_BASE)/$(IMAGE_MAIN) $(IMAGE_SDK_OFFSET) $(FW_BASE)/$(IMAGE_SDK) $(SPIFF_START_OFFSET) $(SPIFF_BIN_OUT)
endif
$(TERMINAL)

Expand Down
6 changes: 6 additions & 0 deletions Sming/SmingCore/Network/DNSServer.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
* Created on March 4, 2016
*/

/** @defgroup dnsserver DNS server
* @brief Provides DNS server
* @ingroup udp
* @{
*/
#ifndef DNSServer_h
#define DNSServer_h

Expand Down Expand Up @@ -83,4 +88,5 @@ class DNSServer : public UdpConnection

};

/** @} */
#endif //DNSServer_h
7 changes: 7 additions & 0 deletions Sming/SmingCore/Network/FTPServer.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
* All files of the Sming Core are provided under the LGPL v3 license.
****/

/** @defgroup ftpserver FTP server
* @brief Provides FTP server
* @ingroup tcpserver
* @{
*/

#ifndef _SMING_CORE_FTPSERVER_H_
#define _SMING_CORE_FTPSERVER_H_

Expand Down Expand Up @@ -33,4 +39,5 @@ class FTPServer: public TcpServer
HashMap<String, String> users;
};

/** @} */
#endif /* _SMING_CORE_FTPServer_H_ */
4 changes: 2 additions & 2 deletions Sming/SmingCore/Network/Http/HttpRequest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -185,12 +185,12 @@ uint32_t HttpRequest::getSslOptions() {
return sslOptions;
}

HttpRequest* HttpRequest::pinCertificate(SSLFingerprints fingerprints) {
HttpRequest* HttpRequest::pinCertificate(const SSLFingerprints& fingerprints) {
sslFingerprint = fingerprints;
return this;
}

HttpRequest* HttpRequest::setSslClientKeyCert(SSLKeyCertPair clientKeyCert) {
HttpRequest* HttpRequest::setSslClientKeyCert(const SSLKeyCertPair& clientKeyCert) {
this->sslClientKeyCert = clientKeyCert;
return this;
}
Expand Down
4 changes: 2 additions & 2 deletions Sming/SmingCore/Network/Http/HttpRequest.h
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ class HttpRequest {
*
* @return bool true of success, false or failure
*/
HttpRequest* pinCertificate(SSLFingerprints fingerprints);
HttpRequest* pinCertificate(const SSLFingerprints& fingerprints);

/**
* @brief Sets client private key, certificate and password from memory
Expand All @@ -103,7 +103,7 @@ class HttpRequest {
*
* @return HttpRequest pointer
*/
HttpRequest* setSslClientKeyCert(SSLKeyCertPair clientKeyCert);
HttpRequest* setSslClientKeyCert(const SSLKeyCertPair& clientKeyCert);
#endif

HttpRequest* setBody(const String& body);
Expand Down
7 changes: 7 additions & 0 deletions Sming/SmingCore/Network/HttpClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
*
****/

/** @defgroup httpclient HTTP client
* @brief Provides HTTP/S client
* @ingroup tcpclient
* @{
*/

#ifndef _SMING_CORE_NETWORK_HTTPCLIENT_H_
#define _SMING_CORE_NETWORK_HTTPCLIENT_H_

Expand Down Expand Up @@ -93,4 +99,5 @@ class HttpClient
#endif
};

/** @} */
#endif /* _SMING_CORE_NETWORK_HTTPCLIENT_H_ */
7 changes: 7 additions & 0 deletions Sming/SmingCore/Network/HttpServer.h
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
*
****/

/** @defgroup httpserver HTTP server
* @brief Provides powerful HTTP/S + Websocket server
* @ingroup tcpserver
* @{
*/

#ifndef _SMING_CORE_HTTPSERVER_H_
#define _SMING_CORE_HTTPSERVER_H_

Expand Down Expand Up @@ -78,4 +84,5 @@ class HttpServer: public TcpServer
BodyParsers bodyParsers;
};

/** @} */
#endif /* _SMING_CORE_HTTPSERVER_H_ */
7 changes: 7 additions & 0 deletions Sming/SmingCore/Network/MqttClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
* All files of the Sming Core are provided under the LGPL v3 license.
****/

/** @defgroup mqttclient MQTT client
* @brief Provides MQTT client
* @ingroup tcpclient
* @{
*/

#ifndef _SMING_CORE_NETWORK_MqttClient_H_
#define _SMING_CORE_NETWORK_MqttClient_H_

Expand Down Expand Up @@ -80,4 +86,5 @@ class MqttClient: protected TcpClient
HashMap<uint16_t, MqttMessageDeliveredCallback> onDeliveryQueue;
};

/** @} */
#endif /* _SMING_CORE_NETWORK_MqttClient_H_ */
5 changes: 5 additions & 0 deletions Sming/SmingCore/Network/NetUtils.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
* All files of the Sming Core are provided under the LGPL v3 license.
****/

/** @defgroup networking Networking
* @{
*/

#ifndef _SMING_CORE_NETWORK_NETUTILS_H_
#define _SMING_CORE_NETWORK_NETUTILS_H_

Expand Down Expand Up @@ -37,4 +41,5 @@ class NetUtils
static bool ipClientRoutingFixed;
};

/** @} */
#endif /* _SMING_CORE_NETWORK_NETUTILS_H_ */
1 change: 1 addition & 0 deletions Sming/SmingCore/Network/NtpClient.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/** @defgroup ntp Network Time Protocol client
* @brief Provides NTP client
* @ingroup datetime
* @ingroup udp
* @{
*/
#ifndef APP_NTPCLIENT_H_
Expand Down
7 changes: 7 additions & 0 deletions Sming/SmingCore/Network/TcpClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
* All files of the Sming Core are provided under the LGPL v3 license.
****/

/** @defgroup tcpclient Clients
* @brief Provides base TCP client
* @ingroup tcp
* @{
*/

#ifndef _SMING_CORE_TCPCLIENT_H_
#define _SMING_CORE_TCPCLIENT_H_

Expand Down Expand Up @@ -83,4 +89,5 @@ class TcpClient : public TcpConnection
int16_t asyncTotalLen = 0;
};

/** @} */
#endif /* _SMING_CORE_TCPCLIENT_H_ */
6 changes: 6 additions & 0 deletions Sming/SmingCore/Network/TcpConnection.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
* All files of the Sming Core are provided under the LGPL v3 license.
****/

/** @defgroup tcp TCP
* @ingroup networking
* @{
*/

#ifndef _SMING_CORE_TCPCONNECTION_H_
#define _SMING_CORE_TCPCONNECTION_H_

Expand Down Expand Up @@ -231,4 +236,5 @@ class TcpConnection
bool useSsl = false;
};

/** @} */
#endif /* _SMING_CORE_TCPCONNECTION_H_ */
Loading

0 comments on commit a93547a

Please sign in to comment.