Firmware
module.h
1 /****************************************************************************
2  *
3  * Copyright (c) 2018 PX4 Development Team. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * 3. Neither the name PX4 nor the names of its contributors may be
16  * used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  ****************************************************************************/
33 
34 #pragma once
35 
36 #include <px4_module.h>
37 #include <px4_module_params.h>
38 
39 extern "C" __EXPORT int module_main(int argc, char *argv[]);
40 
41 
42 class Module : public ModuleBase<Module>, public ModuleParams
43 {
44 public:
45  Module(int example_param, bool example_flag);
46 
47  virtual ~Module() = default;
48 
50  static int task_spawn(int argc, char *argv[]);
51 
53  static Module *instantiate(int argc, char *argv[]);
54 
56  static int custom_command(int argc, char *argv[]);
57 
59  static int print_usage(const char *reason = nullptr);
60 
62  void run() override;
63 
65  int print_status() override;
66 
67 private:
68 
74  void parameters_update(int parameter_update_sub, bool force = false);
75 
76 
77  DEFINE_PARAMETERS(
78  (ParamInt<px4::params::SYS_AUTOSTART>) _param_sys_autostart,
79  (ParamInt<px4::params::SYS_AUTOCONFIG>) _param_sys_autoconfig
80  )
81 };
82 
void run() override
Definition: module.cpp:169
Definition: px4_param.h:313
static int task_spawn(int argc, char *argv[])
Definition: module.cpp:102
int print_status() override
Definition: module.cpp:75
Definition: I2C.hpp:51
Definition: module.h:42
C++ base class for modules/classes using configuration parameters.
Definition: px4_module_params.h:46
static int print_usage(const char *reason=nullptr)
Definition: module.cpp:44
static int custom_command(int argc, char *argv[])
Definition: module.cpp:83
static Module * instantiate(int argc, char *argv[])
Definition: module.cpp:119