Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
R
RIOT
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
cm-projects
RIOT
Commits
fef0be8c
Commit
fef0be8c
authored
6 years ago
by
Joakim Nohlgård
Browse files
Options
Downloads
Patches
Plain Diff
pulse_counter: Editorial changes to docs
parent
9c85ce19
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
drivers/include/pulse_counter.h
+8
-9
8 additions, 9 deletions
drivers/include/pulse_counter.h
with
8 additions
and
9 deletions
drivers/include/pulse_counter.h
+
8
−
9
View file @
fef0be8c
...
@@ -7,16 +7,15 @@
...
@@ -7,16 +7,15 @@
*/
*/
/**
/**
* @defgroup drivers_pulse_counter
extra senso
r
* @defgroup drivers_pulse_counter
Pulse counte
r
* @ingroup drivers_sensors
* @ingroup drivers_sensors
*
*
* The connection between the MCU and the PULSE_COUNTER is based on the
* @brief GPIO based pulse counting driver
* GPIO-interface.
*
*
* @{
* @{
*
*
* @file
* @file
* @brief Driver for the
PULSE_COUNTER extra senso
r
* @brief Driver for the
pulse counte
r
*
*
* @author Hyung-Sin Kim <hs.kim@cs.berkeley.edu>
* @author Hyung-Sin Kim <hs.kim@cs.berkeley.edu>
*/
*/
...
@@ -40,14 +39,14 @@ typedef struct {
...
@@ -40,14 +39,14 @@ typedef struct {
}
pulse_counter_params_t
;
}
pulse_counter_params_t
;
/**
/**
* @brief Device descriptor for a
PULSE_COUNTER
device
* @brief Device descriptor for a
pulse counter
device
*/
*/
typedef
struct
{
typedef
struct
{
int16_t
pulse_count
;
/**< pulse counter */
int16_t
pulse_count
;
/**< pulse counter */
}
pulse_counter_t
;
}
pulse_counter_t
;
/**
/**
* @brief Initialize a
n PULSE_COUNTER
device
* @brief Initialize a
pulse counter
device
*
*
* @param[out] dev device descriptor
* @param[out] dev device descriptor
* @param[in] params configuration parameters
* @param[in] params configuration parameters
...
@@ -58,7 +57,7 @@ typedef struct {
...
@@ -58,7 +57,7 @@ typedef struct {
int
pulse_counter_init
(
pulse_counter_t
*
dev
,
const
pulse_counter_params_t
*
params
);
int
pulse_counter_init
(
pulse_counter_t
*
dev
,
const
pulse_counter_params_t
*
params
);
/**
/**
* @brief Read and reset
PULSE_COUNTER
value
* @brief Read and reset
pulse counter
value
*
*
* @param[in] dev device descriptor of sensor
* @param[in] dev device descriptor of sensor
*
*
...
@@ -67,7 +66,7 @@ int pulse_counter_init(pulse_counter_t *dev, const pulse_counter_params_t *param
...
@@ -67,7 +66,7 @@ int pulse_counter_init(pulse_counter_t *dev, const pulse_counter_params_t *param
int16_t
pulse_counter_read_with_reset
(
const
void
*
dev
);
int16_t
pulse_counter_read_with_reset
(
const
void
*
dev
);
/**
/**
* @brief Read
PULSE_COUNTER
value
* @brief Read
pulse counter
value
*
*
* @param[in] dev device descriptor of sensor
* @param[in] dev device descriptor of sensor
*
*
...
@@ -76,7 +75,7 @@ int16_t pulse_counter_read_with_reset(const void *dev);
...
@@ -76,7 +75,7 @@ int16_t pulse_counter_read_with_reset(const void *dev);
int16_t
pulse_counter_read_without_reset
(
const
void
*
dev
);
int16_t
pulse_counter_read_without_reset
(
const
void
*
dev
);
/**
/**
* @brief Reset
PULSE_COUNTER
value
* @brief Reset
pulse counter
value
*
*
* @param[in] dev device descriptor of sensor
* @param[in] dev device descriptor of sensor
*/
*/
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment