mirror of
https://github.com/merbanan/rtl_433.git
synced 2026-04-17 16:16:55 -04:00
124 lines
4.5 KiB
C
124 lines
4.5 KiB
C
/** @file
|
|
High-level utility functions for decoders.
|
|
|
|
Copyright (C) 2018 Christian Zuckschwerdt
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
*/
|
|
|
|
#ifndef INCLUDE_DECODER_UTIL_H_
|
|
#define INCLUDE_DECODER_UTIL_H_
|
|
|
|
#include <stdarg.h>
|
|
#include "bitbuffer.h"
|
|
#include "data.h"
|
|
#include "r_device.h"
|
|
|
|
#if defined _MSC_VER || defined ESP32 // Microsoft Visual Studio or ESP32
|
|
// MSC and ESP32 have something like C99 restrict as __restrict
|
|
#ifndef restrict
|
|
#define restrict __restrict
|
|
#endif
|
|
#endif
|
|
// Defined in newer <sal.h> for MSVC.
|
|
#ifndef _Printf_format_string_
|
|
#define _Printf_format_string_
|
|
#endif
|
|
|
|
/// Create a new r_device, copy from dev_template if not NULL.
|
|
r_device *create_device(r_device *dev_template);
|
|
|
|
/// Output data.
|
|
void decoder_output_data(r_device *decoder, data_t *data);
|
|
|
|
/// Output a log message.
|
|
void decoder_log(r_device *decoder, int level, char const *func, char const *msg);
|
|
|
|
/// Output a formatted log message.
|
|
void decoder_logf(r_device *decoder, int level, char const *func, _Printf_format_string_ const char *format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 4, 5)))
|
|
#endif
|
|
;
|
|
|
|
// be terse, a maximum msg length of 60 characters is supported on the decoder_output_ functions
|
|
// e.g. "FoobarCorp-XY3000: unexpected type code %02x"
|
|
|
|
/// Output a message.
|
|
void decoder_output_message(r_device *decoder, char const *msg);
|
|
|
|
/// Output a message and the content of a bitbuffer.
|
|
void decoder_output_bitbuffer(r_device *decoder, bitbuffer_t const *bitbuffer, char const *msg);
|
|
|
|
/// Output a message and the content of a bitbuffer.
|
|
/// Usage not recommended.
|
|
void decoder_output_bitbuffer_array(r_device *decoder, bitbuffer_t const *bitbuffer, char const *msg);
|
|
|
|
/// Output a message and the content of a bit row (byte buffer).
|
|
void decoder_output_bitrow(r_device *decoder, uint8_t const *bitrow, unsigned bit_len, char const *msg);
|
|
|
|
// print helpers
|
|
|
|
/// Output a message with args.
|
|
void decoder_output_messagef(r_device *decoder, _Printf_format_string_ char const *restrict format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 2, 3)))
|
|
#endif
|
|
;
|
|
|
|
/// Output a message with args and the content of a bitbuffer.
|
|
void decoder_output_bitbufferf(r_device *decoder, bitbuffer_t const *bitbuffer, _Printf_format_string_ char const *restrict format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 3, 4)))
|
|
#endif
|
|
;
|
|
|
|
/// Output a message with args and the content of a bitbuffer.
|
|
void decoder_output_bitbuffer_arrayf(r_device *decoder, bitbuffer_t const *bitbuffer, _Printf_format_string_ char const *restrict format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 3, 4)))
|
|
#endif
|
|
;
|
|
|
|
/// Output a message with args and the content of a bit row (byte buffer).
|
|
void decoder_output_bitrowf(r_device *decoder, uint8_t const *bitrow, unsigned bit_len, _Printf_format_string_ char const *restrict format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 4, 5)))
|
|
#endif
|
|
;
|
|
|
|
/// Print the content of the bitbuffer.
|
|
void bitbuffer_printf(const bitbuffer_t *bitbuffer, _Printf_format_string_ char const *restrict format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 2, 3)))
|
|
#endif
|
|
;
|
|
|
|
/// Debug print the content of the bitbuffer.
|
|
/// For quick and easy debugging, not for regular usage.
|
|
void bitbuffer_debugf(const bitbuffer_t *bitbuffer, _Printf_format_string_ char const *restrict format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 2, 3)))
|
|
#endif
|
|
;
|
|
|
|
/// Print the content of a bit row (byte buffer).
|
|
void bitrow_printf(uint8_t const *bitrow, unsigned bit_len, _Printf_format_string_ char const *restrict format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 3, 4)))
|
|
#endif
|
|
;
|
|
|
|
/// Debug print the content of a bit row (byte buffer).
|
|
/// For quick and easy debugging, not for regular usage.
|
|
void bitrow_debugf(uint8_t const *bitrow, unsigned bit_len, _Printf_format_string_ char const *restrict format, ...)
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
__attribute__((format(printf, 3, 4)))
|
|
#endif
|
|
;
|
|
|
|
#endif /* INCLUDE_DECODER_UTIL_H_ */
|