hx711: updated sensor block and formatting

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-03-25 14:08:06 -07:00
parent df302ff5db
commit 72c957e700
3 changed files with 65 additions and 65 deletions

View File

@ -1,9 +1,7 @@
/* /*
*
* Author: Rafael da Mata Neri <rafael.neri@gmail.com> * Author: Rafael da Mata Neri <rafael.neri@gmail.com>
* Copyright (c) 2015 Intel Corporation. * Copyright (c) 2015 Intel Corporation.
* *
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of * 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 * this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to * the Software without restriction, including without limitation the rights to

View File

@ -1,9 +1,7 @@
/* /*
*
* Author: Rafael da Mata Neri <rafael.neri@gmail.com> * Author: Rafael da Mata Neri <rafael.neri@gmail.com>
* Copyright (c) 2015 Intel Corporation. * Copyright (c) 2015 Intel Corporation.
* *
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of * 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 * this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to * the Software without restriction, including without limitation the rights to
@ -23,7 +21,6 @@
*/ */
#pragma once #pragma once
#include <unistd.h> #include <unistd.h>
#include <stdlib.h> #include <stdlib.h>
#include <stdint.h> #include <stdint.h>
@ -35,17 +32,25 @@ namespace upm {
/** /**
* @brief HX711 24bit ADC library * @brief HX711 24bit ADC library
* @defgroup hx711 libupm-hx711 * @defgroup hx711 libupm-hx711
* @ingroup generic gpio electric
*/ */
/** /**
* @library hx711
* @sensor hx711
* @comname HX711 24bit Analog-to-Digital Converter
* @type electric
* @man generic
* @web http://www.dfrobot.com/image/data/SEN0160/hx711_english.pdf
* @con gpio
*
* @brief C++ API for HX711 * @brief C++ API for HX711
* *
* [HX711](http://www.dfrobot.com/image/data/SEN0160/hx711_english.pdf) is * The HX711 is a precision 24-bit analog-to-digital converter (ADC)
* a precision 24-bit analog- to-digital converter (ADC) designed for weigh * designed for weigh scales and industrial control applications to
* scales and industrial control applications to interface directly with a * interface directly with a bridge sensor. This module was tested on
* bridge sensor. This module was tested on the Intel Galileo Gen2. * the Intel Galileo Gen2.
* *
* @ingroup hx711 hx711
* @snippet hx711.cxx Interesting * @snippet hx711.cxx Interesting
* @image html hx711.jpeg * @image html hx711.jpeg
*/ */
@ -66,7 +71,6 @@ namespace upm {
*/ */
~HX711(); ~HX711();
/** /**
* Waits for the chip to be ready and returns a reading * Waits for the chip to be ready and returns a reading
* *

View File

@ -1,4 +1,3 @@
//! [Interesting]
%module jsupm_hx711 %module jsupm_hx711
%include "../upm.i" %include "../upm.i"
@ -7,4 +6,3 @@
%} %}
%include "hx711.h" %include "hx711.h"
//! [Interesting]