summaryrefslogtreecommitdiffstats
path: root/scripts/aglsetup.sh
blob: b11a54196e4d7889936b9c74496d8c90641c8b02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
################################################################################
#
# The MIT License (MIT)
#
# Copyright (c) 2016 Stéphane Desneux <sdx@iot.bzh>
#
# 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.
#
################################################################################

# detect if this script is sourced: see http://stackoverflow.com/a/38128348/6255594
SOURCED=0
if [ -n "$ZSH_EVAL_CONTEXT" ]; then 
	[[ $ZSH_EVAL_CONTEXT =~ :file$ ]] && { SOURCED=1; SOURCEDIR=$(cd $(dirname -- $0) && pwd -P); }
elif [ -n "$KSH_VERSION" ]; then
	[[ "$(cd $(dirname -- $0) && pwd -P)/$(basename -- $0)" != "$(cd $(dirname -- ${.sh.file}) && pwd -P)/$(basename -- ${.sh.file})" ]] && { SOURCED=1; SOURCEDIR=$(cd $(dirname -- ${.sh.file}) && pwd -P); }
elif [ -n "$BASH_VERSION" ]; then
	[[ $0 != "$BASH_SOURCE" ]] && { SOURCED=1; SOURCEDIR=$(cd $(dirname -- $BASH_SOURCE) && pwd -P); }
fi

if [ $SOURCED -ne 1 ]; then
	unset SOURCED
	unset SOURCEDIR
    echo "Error: this script needs to be sourced in a supported shell" >&2
    echo "Please check that the current shell is bash, zsh or ksh and run this script as '. $0 <args>'" >&2
    return 1
else
	unset SOURCED
	tmpfile=$(mktemp /tmp/aglsetup.XXXXXXXX)
	$SOURCEDIR/.aglsetup_genconfig.bash -s $tmpfile "$@"
	rc=$?
	unset SOURCEDIR
	if [ $rc -eq 0 ]; then
		source $tmpfile
		rc=$?
	else
		echo "Error: configuration files generation failed. Environment is not ready."
	fi

	rm -f $tmpfile
	unset tmpfile
	return $rc
fi
n><can_message_definition_t>& get_can_message_definition() { return can_message_definition_[active_message_set_]; } const std::vector<obd2_signal_t>& get_obd2_signals() { return obd2_signals_; } uint32_t get_signal_id(obd2_signal_t& sig) { return sig.get_pid(); } uint32_t get_signal_id(can_signal_t& sig) { return sig.get_message()->id; } void set_active_message_set(uint8_t id) { active_message_set_ = id; } void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount); void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount); void logBusStatistics(can_bus_dev_t* buses, const int busCount); bool isBusActive(can_bus_dev_t* bus); }; /// TODO: implement this function as method into can_bus class /// @brief Pre initialize actions made before CAN bus initialization /// @param[in] bus A CanBus struct defining the bus's metadata /// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs. /// @param[in] buses An array of all CAN buses. /// @param[in] busCount The length of the buses array. void pre_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount); /// TODO: implement this function as method into can_bus class /// @brief Post-initialize actions made after CAN bus initialization /// @param[in] bus A CanBus struct defining the bus's metadata /// @param[in] writable Configure the controller in a writable mode. If false, it will be configured as "listen only" and will not allow writes or even CAN ACKs. /// @param[in] buses An array of all CAN buses. /// @param[in] busCount The length of the buses array. void post_initialize(can_bus_dev_t* bus, bool writable, can_bus_dev_t* buses, const int busCount); /// TODO: implement this function as method into can_bus class /// @brief Check if the device is connected to an active CAN bus, i.e. it's received a message in the recent past. /// @return true if a message was received on the CAN bus within CAN_ACTIVE_TIMEOUT_S seconds. bool isBusActive(can_bus_dev_t* bus); /// TODO: implement this function as method into can_bus class /// @brief Log transfer statistics about all active CAN buses to the debug log. /// @param[in] buses An array of active CAN buses. /// @param[in] busCount The length of the buses array. void logBusStatistics(can_bus_dev_t* buses, const int busCount);