flipperzero-firmware/lib/ibutton/ibutton_protocols.h

198 lines
6.4 KiB
C
Raw Normal View History

[FL-3070] iButton system and app refactoring (#2388) * Add 1-wire thermometer example app stub * Working 1-wire thermometer app * Refactor app to use threads * Clean up code, add comments * Add CRC checking * Increase update period * Fix error in fbt * Revert the old update period * Use settable pin in onewire_host * Use settable pin for onewire_slave * Clear EXTI flag after callback, make private methods static in onewire_slave * Do not hardcode GPIO pin number * Remove iButton hal from furi_hal_rfid * Remove most of furi_hal_ibutton * Add some of furi_hal_ibutton back * Slightly neater code * Update CODEOWNERS * Add furi_hal_gpio_get_ext_pin_number * Create README.md * Temporary get Metakom and Cyfral keys out of the way * Better enum name * Syncing work, does not compile * Syncing work, now compiles * Working read impl for DS1990 and DS1992 * Add the ability to display extended key data * Get rid of DialogEx * Add save and load API * Better iButtonKey encapsulation * Fix crash * Load key code boilerplate * More load key code boilerplate * Minor code cleanup * Implement loading and saving DS1990 keys * Implement the Info scene * Implement loading & saving for DS1992 * Implement read error scene stub * Implement delete confirmation screen * Better error messages (protocol-dependent) * Minor old code cleanup * Remove iButtonDevice, add command callback to iButtonSlave * Implement draft emulation for DS1990 * Better emulation for DS1990 * Initial emulation implementation for DS1992 * Better common command definitions * Use common submenu callback, add protocol list * Improve ViewData screen * Improve scene_add_type * Add stubs for write functionality * Improve naming consistency * Implement writing a DS1992 onto another one * Improve DS1992 write code * Improve DS1992 write code once more * Prepare write_blank for DS1990, delete ibutton_writer * Implement writing DS1990 onto blanks * Fix reading DS1990 * Partially implement writing DS1992 onto blanks * Implement GUI for writing keys * Implement GUI for emulating keys * Reduce memory usage for pretty_format * Automatically truncate data more than 256 bytes * Initial implementation of DS1996 (not tested) * Fix crash due to missing virtual function * Improve emulation code * Improve DS1992 emulation code * Correct return value for onewire_slave_send * Correct return value for onewire_slave_receive * Implement emulation for DS1992 & DS1996 * Better constant names * Simplify & optimise the emulation code * Remove duplicate code * Add skip rom command emulation * Show loading animation for large keys * Implement manual adding & editing of keys * Use buffered file streams to speed up saving & loading * Reset key name before adding a new one * Sync a buffered file stream before saving * Use the DSGeneric protocol as a fallback option * Implement emulation via RPC * Refactor iButton code in preparation for comparator keys * Refactor iButton code in preparation for comparator keys once more * Make some functions static * Make protocols not rely on one_wire classes * Improve ProtocolDict usage * Improve ProtocolDict usage more * Implement reading Metakom & Cyfral keys * Rename some files * Better file structure * Implement a unified interface for misc protocols * Implement a unified interface for dallas protocols * Concrete types for Dallas protocols * Implement a unified interface for all key types * Improved type naming * Improved private types * Proper types in protocol definitions * Implement emulation for Cyfral & Metakom keys * Implement save&load for Metakom & Cyfral keys * Better type names * Rename files, better names * Allocate iButtonProtocols like a normal class * Reset the key each time the start scene is selected * Improve comments and constants * Add ibutton_protocols to SDK headers * Add ibutton_key to SDK headers * Add ibutton_key to SDK headers * Implement reading via cli * Implement emulation via cli * Implement writing Dallas blanks via cli * Correctly revert the editing if cancelled by the user * Correct committing mishap * Elide the long text on the info screen * Change key name for data in Misc keys * Update iButtonFileFormat.md * Remember the key's folder * Save menu position in ReadKeyMenu and SavedKeyMenu * Correct use of preselected path in file browser Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2023-03-02 13:23:33 +00:00
/**
* @file ibutton_protocols.h
*
* Common interface for accessing various iButton protocols
*/
#pragma once
#include <stdint.h>
#include <stddef.h>
#include "protocols/protocol_common.h"
#include "ibutton_key.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct iButtonProtocols iButtonProtocols;
/**
* Allocate an iButtonProtocols object
* @return pointer to an iButtonProtocols object
*/
iButtonProtocols* ibutton_protocols_alloc();
/**
* Destroy an iButtonProtocols object, free resources
* @param [in] protocols pointer to an iButtonProtocols object
*/
void ibutton_protocols_free(iButtonProtocols* protocols);
/**
* Get the total number of available protocols
*/
uint32_t ibutton_protocols_get_protocol_count();
/**
* Get maximum data size out of all protocols available
* @param [in] protocols pointer to an iButtonProtocols object
* @return maximum data size in bytes
*/
size_t ibutton_protocols_get_max_data_size(iButtonProtocols* protocols);
/**
* Get the protocol id based on its name
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] name pointer to a string containing the name
* @return protocol id on success on iButtonProtocolIdInvalid on failure
*/
iButtonProtocolId ibutton_protocols_get_id_by_name(iButtonProtocols* protocols, const char* name);
/**
* Get the manufacturer name based on the protocol id
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] id id of the protocol in question
* @return pointer to a statically allocated string with manufacturer name
*/
const char* ibutton_protocols_get_manufacturer(iButtonProtocols* protocols, iButtonProtocolId id);
/**
* Get the protocol name based on the protocol id
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] id id of the protocol in question
* @return pointer to a statically allocated string with protocol name
*/
const char* ibutton_protocols_get_name(iButtonProtocols* protocols, iButtonProtocolId id);
/**
* Get protocol features bitmask by protocol id
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] id id of the protocol in question
*/
uint32_t ibutton_protocols_get_features(iButtonProtocols* protocols, iButtonProtocolId id);
/**
* Read a physical device (a key or an emulator)
* @param [in] protocols pointer to an iButtonProtocols object
* @param [out] key pointer to the key to read into (must be allocated before)
* @return true on success, false on failure
*/
bool ibutton_protocols_read(iButtonProtocols* protocols, iButtonKey* key);
/**
* Write the key to a blank
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be written
* @return true on success, false on failure
*/
bool ibutton_protocols_write_blank(iButtonProtocols* protocols, iButtonKey* key);
/**
* Write the key to another one of the same type
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be written
* @return true on success, false on failure
*/
bool ibutton_protocols_write_copy(iButtonProtocols* protocols, iButtonKey* key);
/**
* Start emulating the key
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be emulated
*/
void ibutton_protocols_emulate_start(iButtonProtocols* protocols, iButtonKey* key);
/**
* Stop emulating the key
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be emulated
*/
void ibutton_protocols_emulate_stop(iButtonProtocols* protocols, iButtonKey* key);
/**
* Save the key data to a file.
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be saved
* @param [in] file_name full absolute path to the file name
* @return true on success, false on failure
*/
bool ibutton_protocols_save(
iButtonProtocols* protocols,
const iButtonKey* key,
const char* file_name);
/**
* Load the key from a file.
* @param [in] protocols pointer to an iButtonProtocols object
* @param [out] key pointer to the key to load into (must be allocated before)
* @param [in] file_name full absolute path to the file name
* @return true on success, false on failure
*/
bool ibutton_protocols_load(iButtonProtocols* protocols, iButtonKey* key, const char* file_name);
/**
* Format a string containing device full data
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be rendered
* @param [out] result pointer to the FuriString instance (must be initialized)
*/
void ibutton_protocols_render_data(
iButtonProtocols* protocols,
const iButtonKey* key,
FuriString* result);
/**
* Format a string containing device brief data
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be rendered
* @param [out] result pointer to the FuriString instance (must be initialized)
*/
void ibutton_protocols_render_brief_data(
iButtonProtocols* protocols,
const iButtonKey* key,
FuriString* result);
/**
* Format a string containing error message (for invalid keys)
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be rendered
* @param [out] result pointer to the FuriString instance (must be initialized)
*/
void ibutton_protocols_render_error(
iButtonProtocols* protocols,
const iButtonKey* key,
FuriString* result);
/**
* Check whether the key data is valid
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be checked
* @return true if data is valid, false otherwise
*/
bool ibutton_protocols_is_valid(iButtonProtocols* protocols, const iButtonKey* key);
/**
* Get a pointer to the key's editable data (for in-place editing)
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in] key pointer to the key to be checked
* @param [out] editable pointer to a structure to contain the editable data
*/
void ibutton_protocols_get_editable_data(
iButtonProtocols* protocols,
const iButtonKey* key,
iButtonEditableData* editable);
/**
* Make all necessary internal adjustments after editing the key
* @param [in] protocols pointer to an iButtonProtocols object
* @param [in,out] key pointer to the key to be adjusted
*/
void ibutton_protocols_apply_edits(iButtonProtocols* protocols, const iButtonKey* key);
#ifdef __cplusplus
}
#endif