Merge from mysensors

.ci/Jenkinsfile

@@ -0,0 +1,18 @@
+#!groovy
+node {
+	deleteDir() // Purge workspace
+	// Checkout the repo to get the necessary groovy scripts (and place it in the required subdirectory)
+	dir('MySensors') {
+		checkout scm
+	}
+	def pipeline = load('MySensors/.ci/pipeline.groovy')
+
+	// Invoke the main pipeline
+	pipeline {
+		library_root = 'MySensors/'       // Location of the MySensors library
+		repository_root = 'MySensors/'    // Location of the repository root
+		github_organization = 'mysensors' // Name of the GitHub Organization
+		repository_name = 'MySensors'     // Name of the repository on GitHub
+		nightly_arduino_ide = false       // Pick Arduino IDE variant to use
+	}
+}

.ci/Jenkinsfile-nightly

@@ -0,0 +1,18 @@
+#!groovy
+node {
+	deleteDir() // Purge workspace
+	// Checkout the repo to get the necessary groovy scripts (and place it in the required subdirectory)
+	dir('MySensors') {
+		checkout scm
+	}
+	def pipeline = load('MySensors/.ci/pipeline.groovy')
+
+	// Invoke the main pipeline
+	pipeline {
+		library_root = 'MySensors/'       // Location of the MySensors library
+		repository_root = 'MySensors/'    // Location of the repository root
+		github_organization = 'mysensors' // Name of the GitHub Organization
+		repository_name = 'MySensors'     // Name of the repository on GitHub
+		nightly_arduino_ide = true        // Pick Arduino IDE variant to use
+	}
+}

.ci/butler.groovy

@@ -0,0 +1,150 @@
+#!groovy
+def call(config) {
+	config.pr.setBuildStatus(config, 'PENDING', 'Toll gate (Butler)', 'Checking...', '${BUILD_URL}flowGraphTable/')
+	if (env.CHANGE_TARGET == 'master' &&
+		(env.CHANGE_AUTHOR != 'bblacey'     && env.CHANGE_AUTHOR != 'd00616'       &&
+		 env.CHANGE_AUTHOR != 'fallberg'    && env.CHANGE_AUTHOR != 'henrikekblad' &&
+		 env.CHANGE_AUTHOR != 'marceloaqno' && env.CHANGE_AUTHOR != 'mfalkvidd'    &&
+		 env.CHANGE_AUTHOR != 'scalz'       && env.CHANGE_AUTHOR != 'tbowmo'       &&
+		 env.CHANGE_AUTHOR != 'tekka007'    && env.CHANGE_AUTHOR != 'user2684'     &&
+		 env.CHANGE_AUTHOR != 'Yveaux'))
+	{
+		config.pr.setBuildStatus(config, 'FAILURE', 'Toll gate (Butler)', 'This pull request targets master. I am afraid that is not permitted for '+env.CHANGE_AUTHOR, '')
+		error "This pull request targets master. That is not permitted!"
+	}
+	else if (env.CHANGE_TARGET == 'master')
+	{
+		echo env.CHANGE_AUTHOR + ' is a valid author for targeting master branch, skipping further validation'
+		dir(config.repository_root) {
+			step([$class: 'GitChangelogRecorder', config: [configFile: 'git-changelog-settings.json',
+				createFileTemplateContent: '''
+# Changelog
+{{#commits}}
+### {{{messageTitle}}}
+{{{messageBody}}}
+[{{hash}}](https://github.com/mysensors/MySensors/commit/{{hash}}) by {{authorName}} at *{{commitTime}}*
+{{/commits}}
+''',
+				createFileTemplateFile: '', createFileUseTemplateContent: true,
+				createFileUseTemplateFile: false, customIssues: [[link: '', name: '', pattern: '', title: ''],
+				[link: '', name: '', pattern: '', title: '']], dateFormat: 'YYYY-MM-dd HH:mm:ss',
+				file: 'ReleaseNotes.md', fromReference: env.CHANGE_TARGET, fromType: 'ref', gitHubApi: '',
+				gitHubApiTokenCredentialsId: '', gitHubIssuePattern: '#([0-9]+)', gitHubToken: '',
+				gitLabApiTokenCredentialsId: '', gitLabProjectName: '', gitLabServer: '', gitLabToken: '',
+				ignoreCommitsIfMessageMatches: '^Merge.*',
+				ignoreCommitsWithoutIssue: false, ignoreTagsIfNameMatches: '',
+				jiraIssuePattern: '\\b[a-zA-Z]([a-zA-Z]+)-([0-9]+)\\b', jiraPassword: '', jiraServer: '',
+				jiraUsername: '', jiraUsernamePasswordCredentialsId: '', mediaWikiPassword: '',
+				mediaWikiTemplateContent: '',	mediaWikiTemplateFile: '', mediaWikiTitle: '', mediaWikiUrl: '',
+				mediaWikiUseTemplateContent: false, mediaWikiUseTemplateFile: false, mediaWikiUsername: '',
+				noIssueName: 'No issue', readableTagName: '/([^/]+?)$', showSummary: false,
+				showSummaryTemplateContent: '', showSummaryTemplateFile: '', showSummaryUseTemplateContent: false,
+				showSummaryUseTemplateFile: false, subDirectory: '', timeZone: 'UTC',
+				toReference: config.git_sha, toType: 'commit', untaggedName: 'Unreleased',
+				useConfigFile: false, useFile: true, useGitHub: true, useGitHubApiTokenCredentials: false,
+				useGitLab: false, useGitLabApiTokenCredentials: false, useIgnoreTagsIfNameMatches: false,
+				useJira: false, useJiraUsernamePasswordCredentialsId: false, useMediaWiki: false,
+				useReadableTagName: false, useSubDirectory: false]
+			])
+		}
+
+		config.pr.setBuildStatus(config, 'SUCCESS', 'Toll gate (Butler)', 'Pass - Well done!', '')
+		config.pr.setBuildStatus(config, 'SUCCESS', 'Toll gate (Release changelog)', '', '${BUILD_URL}execution/node/3/ws/MySensors/ReleaseNotes.md/*view*/')
+		return
+	}
+
+	dir(config.repository_root) {
+		step([$class: 'GitChangelogRecorder', config: [configFile: 'git-changelog-settings.json',
+			createFileTemplateContent: '''
+{{#commits}}
+{{{messageTitle}}}
+{{/commits}}
+''',
+			createFileTemplateFile: '', createFileUseTemplateContent: true,
+			createFileUseTemplateFile: false, customIssues: [[link: '', name: '', pattern: '', title: ''],
+			[link: '', name: '', pattern: '', title: '']], dateFormat: 'YYYY-MM-dd HH:mm:ss',
+			file: 'subjects.txt', fromReference: env.CHANGE_TARGET, fromType: 'ref', gitHubApi: '',
+			gitHubApiTokenCredentialsId: '', gitHubIssuePattern: '#([0-9]+)', gitHubToken: '',
+			gitLabApiTokenCredentialsId: '', gitLabProjectName: '', gitLabServer: '', gitLabToken: '',
+			ignoreCommitsIfMessageMatches: '^Merge.*',
+			ignoreCommitsWithoutIssue: false, ignoreTagsIfNameMatches: '',
+			jiraIssuePattern: '\\b[a-zA-Z]([a-zA-Z]+)-([0-9]+)\\b', jiraPassword: '', jiraServer: '',
+			jiraUsername: '', jiraUsernamePasswordCredentialsId: '', mediaWikiPassword: '',
+			mediaWikiTemplateContent: '',	mediaWikiTemplateFile: '', mediaWikiTitle: '', mediaWikiUrl: '',
+			mediaWikiUseTemplateContent: false, mediaWikiUseTemplateFile: false, mediaWikiUsername: '',
+			noIssueName: 'No issue', readableTagName: '/([^/]+?)$', showSummary: false,
+			showSummaryTemplateContent: '', showSummaryTemplateFile: '', showSummaryUseTemplateContent: false,
+			showSummaryUseTemplateFile: false, subDirectory: '', timeZone: 'UTC',
+			toReference: config.git_sha, toType: 'commit', untaggedName: 'Unreleased',
+			useConfigFile: false, useFile: true, useGitHub: false, useGitHubApiTokenCredentials: false,
+			useGitLab: false, useGitLabApiTokenCredentials: false, useIgnoreTagsIfNameMatches: false,
+			useJira: false, useJiraUsernamePasswordCredentialsId: false, useMediaWiki: false,
+			useReadableTagName: false, useSubDirectory: false]
+		])
+		step([$class: 'GitChangelogRecorder', config: [configFile: 'git-changelog-settings.json',
+			createFileTemplateContent: '''
+{{#commits}}
+{{#messageBodyItems}}
+{{.}}
+{{/messageBodyItems}}
+{{/commits}}
+''',
+			createFileTemplateFile: '', createFileUseTemplateContent: true,
+			createFileUseTemplateFile: false, customIssues: [[link: '', name: '', pattern: '', title: ''],
+			[link: '', name: '', pattern: '', title: '']], dateFormat: 'YYYY-MM-dd HH:mm:ss',
+			file: 'bodies.txt', fromReference: env.CHANGE_TARGET, fromType: 'ref', gitHubApi: '',
+			gitHubApiTokenCredentialsId: '', gitHubIssuePattern: '#([0-9]+)', gitHubToken: '',
+			gitLabApiTokenCredentialsId: '', gitLabProjectName: '', gitLabServer: '', gitLabToken: '',
+			ignoreCommitsIfMessageMatches: '^Merge.*',
+			ignoreCommitsWithoutIssue: false, ignoreTagsIfNameMatches: '',
+			jiraIssuePattern: '\\b[a-zA-Z]([a-zA-Z]+)-([0-9]+)\\b', jiraPassword: '', jiraServer: '',
+			jiraUsername: '', jiraUsernamePasswordCredentialsId: '', mediaWikiPassword: '',
+			mediaWikiTemplateContent: '',	mediaWikiTemplateFile: '', mediaWikiTitle: '', mediaWikiUrl: '',
+			mediaWikiUseTemplateContent: false, mediaWikiUseTemplateFile: false, mediaWikiUsername: '',
+			noIssueName: 'No issue', readableTagName: '/([^/]+?)$', showSummary: false,
+			showSummaryTemplateContent: '', showSummaryTemplateFile: '', showSummaryUseTemplateContent: false,
+			showSummaryUseTemplateFile: false, subDirectory: '', timeZone: 'UTC',
+			toReference: config.git_sha, toType: 'commit', untaggedName: 'Unreleased',
+			useConfigFile: false, useFile: true, useGitHub: false, useGitHubApiTokenCredentials: false,
+			useGitLab: false, useGitLabApiTokenCredentials: false, useIgnoreTagsIfNameMatches: false,
+			useJira: false, useJiraUsernamePasswordCredentialsId: false, useMediaWiki: false,
+			useReadableTagName: false, useSubDirectory: false]
+		])
+	}
+
+	ret = sh(returnStatus: true,
+		script:"""#!/bin/bash
+							cd ${config.repository_root}/.ci
+							./butler.sh""")
+
+	if (fileExists(config.repository_root+'restyling.patch')) {
+		emailext (
+			subject: "PR#${env.CHANGE_ID} - ${env.CHANGE_TITLE} has unfortunate code styling",
+			body: """<p>Greetings!<p>
+			I am afraid your pull request does not follow the MySensors standards with respect to coding style.</p>
+			That is ok, you are perhaps a first time committer to this repository. Please read the <a href="https://www.mysensors.org/download/contributing">code contribution guidelines</a> for help on how to format your code.<p>
+			To assist you, I have prepared a patch for you that will reformat the code according to the coding style required.<br>
+			The patch is attached. You may apply the patch using:<br>
+			git apply restyling.patch<p>
+			If you disagree with me, please discuss it <a href="${env.CHANGE_URL}">here</a>.<p>
+			--<br>
+			Yours sincerely, The Butler, serving the MySensors community""",
+			mimeType: 'text/html', to: env.CHANGE_AUTHOR_EMAIL,
+			attachLog: false, compressLog: false, attachmentsPattern: config.repository_root+'restyling.patch'
+		)
+	}
+	publishHTML([allowMissing: true, alwaysLinkToLastBuild: false, keepAll: true,
+		reportDir: config.repository_root,
+		reportFiles: 'butler.html', reportName: 'The Butler report', reportTitles: ''])
+	if (ret == 1) {
+		config.pr.setBuildStatus(config, 'FAILURE', 'Toll gate (Butler)', 'I am afraid the commit(s) needs some touchup, please check the details...', '${BUILD_URL}The_20Butler_20report/butler.html')
+		currentBuild.currentResult == 'FAILURE'
+		echo "Terminated due to Butler assert" // For BFA
+		echo "You can read the detailed error report here: "+env.BUILD_URL+"The_20Butler_20report/"
+		error 'Terminated due to Butler assert'
+	} else {
+		config.pr.setBuildStatus(config, 'SUCCESS', 'Toll gate (Butler)', 'Pass - Well done!', '${BUILD_URL}The_20Butler_20report/butler.html')
+	}
+}
+
+return this

.ci/butler.sh

@@ -0,0 +1,132 @@
+#!/bin/bash
+# Yes, this script can be improved immensly...
+cd ..
+
+result=0
+
+echo "No subjects are of invalid size - great!<br>" > too_long_subjects.txt
+echo "No subjects with leading lower case characters - great!<br>" > leading_lowercases.txt
+echo "No subjects with trailing periods - great!<br>" > trailing_periods.txt
+echo "No body lines are too wide - great!<br>" > too_long_body_lines.txt
+echo "No keywords are missing in keywords.txt - great!<br>" > missing_keywords.txt
+echo "No keywords in code that don't exist in keywords.txt - great!<br>" > missing_keywords_2.txt
+echo "No keywords in code that don't have Doxygen comments and aren't blacklisted in keywords.txt - great!<br>" > missing_keywords_3.txt
+echo "No lines in keywords.txt using spaces instead of TAB (the Arduino IDE doesn't support space) - great!<br>" > tab_spaces_keywords.txt
+echo "No occurences of the deprecated boolean data type - great!<br>" >> booleans.txt
+
+too_long_subjects=`awk 'length > 72' subjects.txt`
+if [ -n "$too_long_subjects" ]; then
+  echo "<b>Commit subjects that are too wide (&gt;72 characters):</b>" > too_long_subjects.txt
+  echo "$too_long_subjects" >> too_long_subjects.txt
+  sed -i -e 's/$/<br>/' too_long_subjects.txt
+  result=1
+fi
+leading_lowercases=`awk '/^[[:lower:][:punct:]]/' subjects.txt`
+if [ -n "$leading_lowercases" ]; then
+  echo "<b>Commit subjects with leading lowercase characters:</b>" > leading_lowercases.txt
+  echo "$leading_lowercases" >> leading_lowercases.txt
+  sed -i -e 's/$/<br>/' leading_lowercases.txt
+  result=1
+fi
+trailing_periods=`awk '/(\.)$/' subjects.txt`
+if [ -n "$trailing_periods" ]; then
+  echo "<b>Commit subjects with trailing periods:</b>" > trailing_periods.txt
+  echo "$trailing_periods" >> trailing_periods.txt
+  sed -i -e 's/$/<br>/' trailing_periods.txt
+  result=1
+fi
+
+too_long_body_lines=`awk 'length > 72' bodies.txt`
+if [ -n "$too_long_body_lines" ]; then
+  echo "<b>Body lines that are too wide (&gt;72 characters):</b>" > too_long_body_lines.txt
+  echo "$too_long_body_lines" >> too_long_body_lines.txt
+  sed -i -e 's/$/<br>/' too_long_body_lines.txt
+  result=1
+fi
+
+missing_keywords=$(for keyword in $(grep -A999 '#if DOXYGEN' MyConfig.h | grep -B999 '#endif' | grep '#define' | awk '{ print $2 '} | grep -e '^MY_'); do grep -q $keyword keywords.txt || echo $keyword; done)
+if [ -n "$missing_keywords" ]; then
+  echo "<b>Keywords that are missing from keywords.txt:</b>" > missing_keywords.txt
+  echo "$missing_keywords" >> missing_keywords.txt
+  sed -i -e 's/$/<br>/' missing_keywords.txt
+  result=1
+fi
+
+missing_keywords_2=$(SOURCE_FILES="core/ drivers/ hal/ examples/ examples_linux/ MyConfig.h MySensors.h"; for keyword in $(grep -whore  'MY_[A-Z][A-Z_0-9]*' $SOURCE_FILES | sort -u ); do grep -q $keyword keywords.txt || echo $keyword; done)
+if [ -n "$missing_keywords_2" ]; then
+  echo "<b>Keywords in code that don't exist in keywords.txt:</b>" > missing_keywords_2.txt
+  echo "If keywords aren't in keywords.txt, they will not be highlighted in the Arduino IDE. Highlighting makes the code easier to follow and helps spot spelling mistakes." > missing_keywords_2.txt
+  echo "$missing_keywords_2" >> missing_keywords_2.txt
+  sed -i -e 's/$/<br>/' missing_keywords_2.txt
+  result=1
+fi
+
+missing_keywords_3=$(SOURCE_FILES="core/ drivers/ hal/ examples/ examples_linux/ MyConfig.h MySensors.h"; for keyword in $(grep -whore  'MY_[A-Z][A-Z_0-9]*' $SOURCE_FILES | sort -u ); do grep -q $keyword keywords.txt || echo $keyword; done)
+if [ -n "$missing_keywords_3" ]; then
+  echo "<b>Keywords in code that don't have Doxygen comments and aren't blacklisted in keywords.txt:</b>" > missing_keywords_3.txt
+  echo "If keywords don't have Doxygen comments, they will not be available at https://www.mysensors.org/apidocs/index.html Add Doxygen comments to make it easier for users to find and understand how to use the new keywords." > missing_keywords_3.txt
+  echo "$missing_keywords_3" >> missing_keywords_3.txt
+  sed -i -e 's/$/<br>/' missing_keywords_3.txt
+  result=1
+fi
+
+
+tab_spaces_keywords=$(grep -e '[[:space:]]KEYWORD' -e '[[:space:]]LITERAL1' keywords.txt | grep -v -e $'\tLITERAL1' -e $'\tKEYWORD')
+if [ -n "$tab_spaces_keywords" ]; then
+  echo "<b>Keywords that use space instead of TAB in keywords.txt:</b>" > tab_spaces_keywords.txt
+  echo "$tab_spaces_keywords" >> tab_spaces_keywords.txt
+  sed -i -e 's/$/<br>/' tab_spaces_keywords.txt
+  result=1
+fi
+
+# Evaluate if there exists booleans in the code tree (not counting this file)
+if git grep -q boolean -- `git ls-files | grep -v butler.sh`; then
+  echo "<b>You have added at least one occurence of the deprecated boolean data type. Please use bool instead.</b><br>" > booleans.txt
+  result=1
+fi
+
+printf "%s" "<html>" > butler.html
+echo "Greetings! Here is my evaluation of your pull request:<br>" >> butler.html
+awk 'FNR==1{print "<br>"}1' too_long_subjects.txt leading_lowercases.txt trailing_periods.txt too_long_body_lines.txt missing_keywords.txt missing_keywords_2.txt missing_keywords_3.txt tab_spaces_keywords.txt booleans.txt >> butler.html
+echo "<br>" >> butler.html
+if [ $result -ne 0 ]; then
+	echo "<b>I am afraid there are some issues with your commit messages and/or use of keywords.</b><br>" >> butler.html
+	echo "I highly recommend reading <a href="http://chris.beams.io/posts/git-commit">this guide</a> for tips on how to write a good commit message.<br>" >> butler.html
+	echo "More specifically, MySensors have some <a href="https://www.mysensors.org/download/contributing">code contribution guidelines</a> that I am afraid all contributers need to follow.<br>" >> butler.html
+	echo "<br>" >> butler.html
+	echo "I can help guide you in how to change the commit message for a single-commit pull request:<br>" >> butler.html
+	echo "git checkout &lt;your_branch&gt;<br>" >> butler.html
+	echo "git commit --amend<br>" >> butler.html
+	echo "git push origin HEAD:&lt;your_branch_on_github&gt; -f<br>" >> butler.html
+	echo "<br>" >> butler.html
+	echo "To change the commit messages for a multiple-commit pull request:<br>" >> butler.html
+	echo "git checkout &lt;your_branch&gt;<br>" >> butler.html
+	echo "git rebase -i &lt;sha_of_parent_to_the_earliest_commit_you_want_to_change&gt;<br>" >> butler.html
+	echo "Replace \"pick\" with \"r\" or \"reword\" on the commits you need to change message for<br>" >> butler.html
+	echo "git push origin HEAD:&lt;your_branch_on_github&gt; -f<br>" >> butler.html
+	echo "<br>" >> butler.html
+fi
+
+# Evaluate coding style
+astyle --options=.mystools/astyle/config/style.cfg -nq --recursive "*.h" "*.c" "*.cpp"
+git diff > restyling.patch
+if [ -s restyling.patch ]; then
+	echo "I am afraid your coding style is not entirely in line with the MySensors prefered style.<b><br>A mail with a patch has been sent to you that, if applied to your PR, will make it follow the MySensors coding standards.</b><br>" >> butler.html
+	echo "You can apply the patch using:<br>" >> butler.html
+	echo "git apply restyling.patch<br>" >> butler.html
+	echo "<br>" >> butler.html
+	result=1
+else
+	echo "This commit is meeting the coding standards, well done!<br>" >> butler.html
+	echo "<br>" >> butler.html
+	rm restyling.patch
+fi
+
+if [ $result -ne 0 ]; then
+	echo "If you have any questions, please first read the <a href="https://www.mysensors.org/download/contributing">code contribution guidelines</a>.</b><br>" >> butler.html
+	echo "<b>If you disagree to this, please discuss it in the GitHub pull request thread.</b><br>" >> butler.html
+	echo "<br>" >> butler.html
+fi
+echo "Yours sincerely, The Butler, serving the MySensors community<br>" >> butler.html
+printf "%s" "</html>" >> butler.html
+exit $result

.ci/doxygen.groovy

@@ -0,0 +1,40 @@
+#!groovy
+def call(config) {
+	config.pr.setBuildStatus(config, 'PENDING', 'Toll gate (Documentation)', 'Generating...', '${BUILD_URL}flowGraphTable/')
+	sh """#!/bin/bash
+				cd ${config.repository_root}
+				Documentation/doxygen.sh"""
+	warnings canComputeNew: false, canResolveRelativePaths: false,
+		defaultEncoding: '',
+		excludePattern: '''.*/hal/architecture/Linux/drivers/.*,.*/hal/architecture/AVR/drivers/.*,.*/drivers/TinyGSM/.*''',
+		failedTotalAll: '', healthy: '', includePattern: '', messagesPattern: '',
+		parserConfigurations: [[parserName: 'Doxygen', pattern: config.repository_root+'doxygen.log']],
+		unHealthy: '', unstableTotalAll: '0'
+	publishHTML([allowMissing: false, alwaysLinkToLastBuild: false, keepAll: true,
+		reportDir: config.repository_root+'Documentation/html',
+		reportFiles: 'index.html', reportName: 'Doxygen HTML', reportTitles: ''])
+
+	if (!config.is_pull_request)
+	{
+		// Publish docs to API server
+		if (env.BRANCH_NAME == 'master') {
+			sh """#!/bin/bash
+						scp -r ${config.repository_root}Documentation/html docs@direct.openhardware.io:"""
+		} else if (env.BRANCH_NAME == 'development') {
+			sh """#!/bin/bash
+						scp -r ${config.repository_root}Documentation/html docs@direct.openhardware.io:beta"""
+		}
+	} else {
+		if (currentBuild.currentResult == 'UNSTABLE') {
+			config.pr.setBuildStatus(config, 'ERROR', 'Toll gate (Documentation)', 'Warnings found', '${BUILD_URL}warnings16Result/new')
+			error 'Terminating due to doxygen error'
+		} else if (currentBuild.currentResult == 'FAILURE') {
+			config.pr.setBuildStatus(config, 'FAILURE', 'Toll gate (Documentation)', 'Error generating documentation', '${BUILD_URL}flowGraphTable/')
+			error 'Terminating due to doxygen error'
+		} else {
+			config.pr.setBuildStatus(config, 'SUCCESS', 'Toll gate (Documentation)', 'Pass', '${BUILD_URL}Doxygen_HTML/index.html')
+		}
+	}
+}
+
+return this