Commit Graph

1109 Commits

Author SHA1 Message Date
Uwe Hermann 6b2d8d3e5c Doxygen: TODO cleanup, use @todo where needed.
Turn TODOs which should be user-visible into @todo so that Doxygen
shows them in the function docs, and also on the special "Todo List" page.

Those TODOs that should not be in the Doxygen docs are moved out of the
/** */ comment blocks.

Also fix some comments/items, and remove some obsolete ones.
2012-10-22 11:56:18 +02:00
Uwe Hermann 3c0839d524 Doxygen: Various improvements in libsigrok.h.
- Turn SR_OK/SR_ERR_* and SR_LOG_* into proper enums.

 - Use /**< Foo. */ for Doxygen comments that are on the same line as
   the (e.g.) enum entry they document. If the comment is not on the
   same line (but rather directly above the enum entry) a simple
   /** Foo. */ comment is sufficient.

 - Use /** */ instead of /* */ in some places, so that Doxygen actually uses
   the respective comments.

 - Various smaller cosmetic fixes or cleanups.
2012-10-22 11:56:18 +02:00
Uwe Hermann 9c5332d291 Doxygen: Fix a bunch of warnings and outdated docs. 2012-10-22 11:56:18 +02:00
Uwe Hermann f21193fa03 Doxygen: Move error handling stuff to error.c.
Also, add an overview mini-section to the main page instead.
2012-10-22 11:56:18 +02:00
Uwe Hermann 7b870c38e3 Doxygen: Initial groups and topic short descriptions. 2012-10-22 11:56:18 +02:00
Uwe Hermann b4bd70889f Doxygen: Mark non-public stuff for exclusion.
- /** @private */ can be used for functions, and /** @cond PRIVATE */ and
   /** @endcond */ for variables or #defines.

 - Document the above in HACKING.
2012-10-22 11:56:17 +02:00
Uwe Hermann 5b30cca719 Doxygen: Add initial main page documentation section. 2012-10-22 11:56:17 +02:00
Uwe Hermann d5f1d5382d Doxyfile: Various additions/improvements.
- Show a short project description, the libsigrok version (x.y.z or
   "unreleased development snapshot"), and the sigrok logo in the
   Doxygen output.

 - Ignore a bunch of files and directories which don't contain public
   libsigrok API anyway.

 - Remove the SR_API prefix from the Doxygen output (all
   functions/symbols in the output are part of the public API anyway).

 - Various changes of settings to get nicer and more useful output.
2012-10-22 11:56:17 +02:00
Uwe Hermann e61b4fa0d0 Doxygen: Add sigrok logo PNG for use by Doxygen. 2012-10-22 11:56:17 +02:00
Uwe Hermann c63eac737c Doxyfile: Update to what doxygen 1.8.1.2 generates.
The new version has a number of neat improvements/features we could use.
2012-10-22 11:56:17 +02:00
Uwe Hermann 296821683d Makefile.am: Add missing backslash. 2012-10-22 11:54:40 +02:00
Uwe Hermann 8e2d43cc97 backend.c: Revert accidentally committed test code. 2012-10-22 10:17:38 +02:00
Bert Vermeulen 589a10135a clean up autoconf/autobuild scripts 2012-10-22 01:48:39 +02:00
Uwe Hermann d11d606626 We now require libusb >= 1.0.9.
This is due to the use of libusb_error_name().
2012-10-21 22:44:00 +02:00
Uwe Hermann c46762a285 sr_init/sr_exit: Improve docs, add error checks. 2012-10-21 22:40:43 +02:00
Peter Stuge 785b9ff290 Add and init libusb_context * in struct sr_context when using libusb-1.0
This allows hardware drivers to use a common libusb_context.
2012-10-21 20:23:36 +02:00
Peter Stuge b8072700c1 Add a struct sr_context * parameter to sr_init() and sr_exit() 2012-10-21 20:23:14 +02:00
Uwe Hermann 026c822d8c Move 'struct drv_context' to sigrok-internal.h.
It's not meant to be visible to frontends.
2012-10-21 16:40:13 +02:00
Alexandru Gagniuc 7c41dc4774 radioshack-dmm: Implement support for "LOGIC" mode
LOGIC mode sends the following data:
     V < 0 : actual voltage
0 <= V < 1 : LOW
1 <= V < 2 : actual voltage
2 <= V     : HIGH

We follow the same idea, and set our unit to BOOLEAN for the crazy
case (HIGH or LOW).

Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
2012-10-20 23:03:51 +02:00
Alexandru Gagniuc dfd8f56ef4 libsigrok: (Trivial) fix packet type in datafeed_dump
datafeed_dump would print SR_DF_META_LOGIC when a SR_DF_META_ANALOG
was recieved. Fix that.

Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
2012-10-20 23:03:51 +02:00
Alexandru Gagniuc 0f70830194 libsigrok: (Trivial) Add support for 2400 baud
Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
2012-10-20 23:02:14 +02:00
Bert Vermeulen 777bbd5b98 add SR_HWOPT_* documentation 2012-10-18 22:59:32 +02:00
Bert Vermeulen fe31f8b9f9 fluke-dmm: add support for Fluke 187 2012-10-16 23:33:54 +02:00
Bert Vermeulen 796a79eb75 analog: add pretty-printer for dBu and dBV 2012-10-16 23:33:54 +02:00
Bert Vermeulen 6b86923463 add SR_UNIT_DECIBEL_VOLT (dBu) 2012-10-16 23:33:54 +02:00
Bert Vermeulen d713e56181 analog: sane printing of very small and negative values 2012-10-16 23:33:54 +02:00
Uwe Hermann 8ed262509f HACKING: Cosmetics. 2012-10-16 14:48:39 +02:00
Uwe Hermann 6aff0d16df Build fix for Windows/MinGW.
On Window/MinGW 'recv' seems to be already defined in some headers.
Use 'receive' instead, for now.
2012-10-16 12:19:36 +02:00
Uwe Hermann a2353f6051 Re-add HACKING file after repo split. 2012-10-16 12:19:36 +02:00
Alexandru Gagniuc be8dbf3ab2 radioshack-dmm: (Trivial) Convenience fixes
While testing the new radioshack-dmm driver with pulseview, I found
a few inconvenients.

1. Print an info message when a port is probed, and when a device is
found. This makes it easy to tell if and where the driver is looking.

2. num_samples was not reset after the first aquisition, so the
second aquisition would quit right away. Reset num_samples at start
of a new aquisition.

3. There's no need to  open the serial port RW, so change O_RDWR to
O_RDONLY when opening the port.

These changes are too trivial to split into different patches.

Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
2012-10-16 11:16:41 +02:00
Bert Vermeulen 7b0a85c81c radioshack-dmm: build fixes 2012-10-15 18:25:48 +02:00
Alexandru Gagniuc d375b3c3ec radioshack-dmm: Add support for Radioshack 22-812 DMM
Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
2012-10-15 17:32:58 +02:00
Alexandru Gagniuc b82a17d370 libsigrok.h: Add measured quantity and units used by Radioshack 22-812
The Radioshack 22-812 can measure parameters such as transistor gain,
dbm, etc. Add those to libsigrok.h.

The SR_UNIT_UNITLESS is for quantities that do not have units. Any
ratio or gain are just factors, whic do not have units. Specifically,
a transistor's gain, or hFE, is a unitless quantity.

Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
2012-10-15 17:32:58 +02:00
Alexandru Gagniuc e8e9dcdd70 serial: (Trivial) add support for 4800 baud
Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
2012-10-15 17:32:58 +02:00
Alexandru Gagniuc 5fef6b9d6c .qitignore: Ignore KDE backup files
*.kate-swp files can become annoying, so ignore them.

Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
2012-10-15 17:31:19 +02:00
Bert Vermeulen 2b98e0aaab analog: support AC+DC unit modifier 2012-10-15 11:32:36 +02:00
Bert Vermeulen 17ff11240e don't accept numbers as probe identifiers in trigger string
Only the probe name, as supplied by the device driver, is accepted.
2012-10-14 14:59:07 +02:00
Uwe Hermann 33df15f144 Quick workaround for g_match_info_unref(). 2012-10-11 23:57:26 +02:00
Uwe Hermann 4a1c927fd6 README: Add status, update URL, small fixes. 2012-10-10 23:36:32 +02:00
Bert Vermeulen a5b2293fa8 updated URLs and description 2012-10-08 18:52:36 +02:00
Bert Vermeulen c750b9b194 restore pre-split ignores 2012-10-08 15:53:00 +02:00
Uwe Hermann a2e222d24f sr: struct drv_context is global now. 2012-09-27 23:29:33 +02:00
Bert Vermeulen d38d2ef0ce fluke-dmm: support for all basic 287 functionality 2012-09-25 19:53:05 +02:00
Bert Vermeulen 96b3b3d568 sr: add support for conductance measurements in Siemens 2012-09-25 19:53:05 +02:00
Bert Vermeulen aa839a5c4f sr: add support for pulse width measurements 2012-09-25 19:53:05 +02:00
Bert Vermeulen f46a36ad80 fluke-dmm: definitely use CR as line terminator 2012-09-25 19:53:05 +02:00
Bert Vermeulen acd29accb3 fluke-dmm: add Fluke 287 to supported list 2012-09-25 19:53:05 +02:00
Bert Vermeulen fb9d3bf9cc sr: always turn off ICRNL on serial ports
It does rather screw with protocols that use CR.
2012-09-25 19:53:05 +02:00
Bert Vermeulen d3f8f1415c fluke-dmm: flesh out the driver API 2012-09-25 19:53:05 +02:00
Bert Vermeulen 4129832014 fluke-dmm: auto-discover serial bitrate if not provided 2012-09-25 19:53:05 +02:00