flipperzero-firmware/lib/subghz/environment.h
Skorpionm 94ba7d104c
SubGhz: refactoring add descriptions (#1012)
* SubGhz: add descriptions
* SubGhz: fix syntax

Co-authored-by: あく <alleteam@gmail.com>
2022-03-16 16:18:48 +07:00

67 lines
1.9 KiB
C

#pragma once
#include <furi.h>
#include "subghz_keystore.h"
typedef struct SubGhzEnvironment SubGhzEnvironment;
/**
* Allocate SubGhzEnvironment.
* @return SubGhzEnvironment* pointer to a SubGhzEnvironment instance
*/
SubGhzEnvironment* subghz_environment_alloc();
/**
* Free SubGhzEnvironment.
* @param instance Pointer to a SubGhzEnvironment instance
*/
void subghz_environment_free(SubGhzEnvironment* instance);
/**
* Downloading the manufacture key file.
* @param instance Pointer to a SubGhzEnvironment instance
* @param filename Full path to the file
* @return true On succes
*/
bool subghz_environment_load_keystore(SubGhzEnvironment* instance, const char* filename);
/**
* Get pointer to a SubGhzKeystore* instance.
* @return SubGhzEnvironment* pointer to a SubGhzEnvironment instance
*/
SubGhzKeystore* subghz_environment_get_keystore(SubGhzEnvironment* instance);
/**
* Set filename to work with Came Atomo.
* @param instance Pointer to a SubGhzEnvironment instance
* @param filename Full path to the file
*/
void subghz_environment_set_came_atomo_rainbow_table_file_name(
SubGhzEnvironment* instance,
const char* filename);
/**
* Get filename to work with Came Atomo.
* @param instance Pointer to a SubGhzEnvironment instance
* @return Full path to the file
*/
const char* subghz_environment_get_came_atomo_rainbow_table_file_name(SubGhzEnvironment* instance);
/**
* Set filename to work with Nice Flor-S.
* @param instance Pointer to a SubGhzEnvironment instance
* @param filename Full path to the file
*/
void subghz_environment_set_nice_flor_s_rainbow_table_file_name(
SubGhzEnvironment* instance,
const char* filename);
/**
* Get filename to work with Nice Flor-S.
* @param instance Pointer to a SubGhzEnvironment instance
* @return Full path to the file
*/
const char*
subghz_environment_get_nice_flor_s_rainbow_table_file_name(SubGhzEnvironment* instance);