[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>
This commit is contained in:
Georgii Surkov
GitHub
@@ -5,127 +5,49 @@
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <stdint.h>
|
||||
|
||||
#include <core/string.h>
|
||||
|
||||
#include "protocols/protocol_common.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#define IBUTTON_KEY_DATA_SIZE 8
|
||||
#define IBUTTON_KEY_NAME_SIZE 22
|
||||
|
||||
typedef enum {
|
||||
iButtonKeyDS1990,
|
||||
iButtonKeyCyfral,
|
||||
iButtonKeyMetakom,
|
||||
} iButtonKeyType;
|
||||
|
||||
typedef struct iButtonKey iButtonKey;
|
||||
|
||||
/**
|
||||
* Allocate key
|
||||
* @return iButtonKey*
|
||||
* Allocate a key object
|
||||
* @param [in] data_size maximum data size held by the key
|
||||
* @return pointer to the key object
|
||||
*/
|
||||
iButtonKey* ibutton_key_alloc();
|
||||
iButtonKey* ibutton_key_alloc(size_t data_size);
|
||||
|
||||
/**
|
||||
* Free key
|
||||
* @param key
|
||||
* Destroy the key object, free resources
|
||||
* @param [in] key pointer to the key object
|
||||
*/
|
||||
void ibutton_key_free(iButtonKey* key);
|
||||
|
||||
/**
|
||||
* Copy key
|
||||
* @param to
|
||||
* @param from
|
||||
* Get the protocol id held by the key
|
||||
* @param [in] key pointer to the key object
|
||||
* @return protocol id held by the key
|
||||
*/
|
||||
void ibutton_key_set(iButtonKey* to, const iButtonKey* from);
|
||||
iButtonProtocolId ibutton_key_get_protocol_id(const iButtonKey* key);
|
||||
|
||||
/**
|
||||
* Set key data
|
||||
* @param key
|
||||
* @param data
|
||||
* @param data_count
|
||||
* Set the protocol id held by the key
|
||||
* @param [in] key pointer to the key object
|
||||
* @param [in] protocol_id new protocol id
|
||||
*/
|
||||
void ibutton_key_set_data(iButtonKey* key, uint8_t* data, uint8_t data_count);
|
||||
void ibutton_key_set_protocol_id(iButtonKey* key, iButtonProtocolId protocol_id);
|
||||
|
||||
/**
|
||||
* Clear key data
|
||||
* @param key
|
||||
* Reset the protocol id and data held by the key
|
||||
* @param [in] key pointer to the key object
|
||||
*/
|
||||
void ibutton_key_clear_data(iButtonKey* key);
|
||||
|
||||
/**
|
||||
* Get pointer to key data
|
||||
* @param key
|
||||
* @return const uint8_t*
|
||||
*/
|
||||
const uint8_t* ibutton_key_get_data_p(iButtonKey* key);
|
||||
|
||||
/**
|
||||
* Get key data size
|
||||
* @param key
|
||||
* @return uint8_t
|
||||
*/
|
||||
uint8_t ibutton_key_get_data_size(iButtonKey* key);
|
||||
|
||||
/**
|
||||
* Set key type
|
||||
* @param key
|
||||
* @param key_type
|
||||
*/
|
||||
void ibutton_key_set_type(iButtonKey* key, iButtonKeyType key_type);
|
||||
|
||||
/**
|
||||
* Get key type
|
||||
* @param key
|
||||
* @return iButtonKeyType
|
||||
*/
|
||||
iButtonKeyType ibutton_key_get_type(iButtonKey* key);
|
||||
|
||||
/**
|
||||
* Get type string from key type
|
||||
* @param key_type
|
||||
* @return const char*
|
||||
*/
|
||||
const char* ibutton_key_get_string_by_type(iButtonKeyType key_type);
|
||||
|
||||
/**
|
||||
* Get key type from string
|
||||
* @param type_string
|
||||
* @param key_type
|
||||
* @return bool
|
||||
*/
|
||||
bool ibutton_key_get_type_by_string(const char* type_string, iButtonKeyType* key_type);
|
||||
|
||||
/**
|
||||
* Get key data size from type
|
||||
* @param key_type
|
||||
* @return uint8_t
|
||||
*/
|
||||
uint8_t ibutton_key_get_size_by_type(iButtonKeyType key_type);
|
||||
|
||||
/**
|
||||
* Get max key size
|
||||
* @return uint8_t
|
||||
*/
|
||||
uint8_t ibutton_key_get_max_size();
|
||||
|
||||
/**
|
||||
* Check if CRC for onewire key is valid
|
||||
* @param key
|
||||
* @return true
|
||||
* @return false
|
||||
*/
|
||||
bool ibutton_key_dallas_crc_is_valid(iButtonKey* key);
|
||||
|
||||
/**
|
||||
* Check if onewire key is a DS1990 key
|
||||
* @param key
|
||||
* @return true
|
||||
* @return false
|
||||
*/
|
||||
bool ibutton_key_dallas_is_1990_key(iButtonKey* key);
|
||||
void ibutton_key_reset(iButtonKey* key);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user