[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
@@ -1,23 +1,28 @@
|
||||
#include <furi.h>
|
||||
#include <furi_hal.h>
|
||||
#include "ibutton_worker_i.h"
|
||||
#include "ibutton_key_command.h"
|
||||
|
||||
void ibutton_worker_mode_idle_start(iButtonWorker* worker);
|
||||
void ibutton_worker_mode_idle_tick(iButtonWorker* worker);
|
||||
void ibutton_worker_mode_idle_stop(iButtonWorker* worker);
|
||||
#include <core/check.h>
|
||||
|
||||
void ibutton_worker_mode_emulate_start(iButtonWorker* worker);
|
||||
void ibutton_worker_mode_emulate_tick(iButtonWorker* worker);
|
||||
void ibutton_worker_mode_emulate_stop(iButtonWorker* worker);
|
||||
#include <furi_hal_rfid.h>
|
||||
#include <furi_hal_power.h>
|
||||
|
||||
void ibutton_worker_mode_read_start(iButtonWorker* worker);
|
||||
void ibutton_worker_mode_read_tick(iButtonWorker* worker);
|
||||
void ibutton_worker_mode_read_stop(iButtonWorker* worker);
|
||||
#include "ibutton_protocols.h"
|
||||
|
||||
void ibutton_worker_mode_write_start(iButtonWorker* worker);
|
||||
void ibutton_worker_mode_write_tick(iButtonWorker* worker);
|
||||
void ibutton_worker_mode_write_stop(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_idle_start(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_idle_tick(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_idle_stop(iButtonWorker* worker);
|
||||
|
||||
static void ibutton_worker_mode_emulate_start(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_emulate_tick(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_emulate_stop(iButtonWorker* worker);
|
||||
|
||||
static void ibutton_worker_mode_read_start(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_read_tick(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_read_stop(iButtonWorker* worker);
|
||||
|
||||
static void ibutton_worker_mode_write_common_start(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_write_blank_tick(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_write_copy_tick(iButtonWorker* worker);
|
||||
static void ibutton_worker_mode_write_common_stop(iButtonWorker* worker);
|
||||
|
||||
const iButtonWorkerModeType ibutton_worker_modes[] = {
|
||||
{
|
||||
@@ -34,9 +39,15 @@ const iButtonWorkerModeType ibutton_worker_modes[] = {
|
||||
},
|
||||
{
|
||||
.quant = 1000,
|
||||
.start = ibutton_worker_mode_write_start,
|
||||
.tick = ibutton_worker_mode_write_tick,
|
||||
.stop = ibutton_worker_mode_write_stop,
|
||||
.start = ibutton_worker_mode_write_common_start,
|
||||
.tick = ibutton_worker_mode_write_blank_tick,
|
||||
.stop = ibutton_worker_mode_write_common_stop,
|
||||
},
|
||||
{
|
||||
.quant = 1000,
|
||||
.start = ibutton_worker_mode_write_common_start,
|
||||
.tick = ibutton_worker_mode_write_copy_tick,
|
||||
.stop = ibutton_worker_mode_write_common_stop,
|
||||
},
|
||||
{
|
||||
.quant = 1000,
|
||||
@@ -62,143 +73,18 @@ void ibutton_worker_mode_idle_stop(iButtonWorker* worker) {
|
||||
|
||||
/*********************** READ ***********************/
|
||||
|
||||
typedef struct {
|
||||
uint32_t last_dwt_value;
|
||||
FuriStreamBuffer* stream;
|
||||
} iButtonReadContext;
|
||||
|
||||
void ibutton_worker_comparator_callback(bool level, void* context) {
|
||||
iButtonReadContext* read_context = context;
|
||||
|
||||
uint32_t current_dwt_value = DWT->CYCCNT;
|
||||
|
||||
LevelDuration data =
|
||||
level_duration_make(level, current_dwt_value - read_context->last_dwt_value);
|
||||
furi_stream_buffer_send(read_context->stream, &data, sizeof(LevelDuration), 0);
|
||||
|
||||
read_context->last_dwt_value = current_dwt_value;
|
||||
}
|
||||
|
||||
bool ibutton_worker_read_comparator(iButtonWorker* worker) {
|
||||
bool result = false;
|
||||
|
||||
protocol_dict_decoders_start(worker->protocols);
|
||||
|
||||
furi_hal_rfid_pins_reset();
|
||||
// pulldown pull pin, we sense the signal through the analog part of the RFID schematic
|
||||
furi_hal_rfid_pin_pull_pulldown();
|
||||
|
||||
iButtonReadContext read_context = {
|
||||
.last_dwt_value = DWT->CYCCNT,
|
||||
.stream = furi_stream_buffer_alloc(sizeof(LevelDuration) * 512, 1),
|
||||
};
|
||||
|
||||
furi_hal_rfid_comp_set_callback(ibutton_worker_comparator_callback, &read_context);
|
||||
furi_hal_rfid_comp_start();
|
||||
|
||||
uint32_t tick_start = furi_get_tick();
|
||||
while(true) {
|
||||
LevelDuration level;
|
||||
size_t ret =
|
||||
furi_stream_buffer_receive(read_context.stream, &level, sizeof(LevelDuration), 100);
|
||||
|
||||
if((furi_get_tick() - tick_start) > 100) {
|
||||
break;
|
||||
}
|
||||
|
||||
if(ret > 0) {
|
||||
ProtocolId decoded_index = protocol_dict_decoders_feed(
|
||||
worker->protocols,
|
||||
level_duration_get_level(level),
|
||||
level_duration_get_duration(level));
|
||||
|
||||
if(decoded_index == PROTOCOL_NO) continue;
|
||||
|
||||
protocol_dict_get_data(
|
||||
worker->protocols, decoded_index, worker->key_data, ibutton_key_get_max_size());
|
||||
|
||||
switch(decoded_index) {
|
||||
case iButtonProtocolCyfral:
|
||||
furi_check(worker->key_p != NULL);
|
||||
ibutton_key_set_type(worker->key_p, iButtonKeyCyfral);
|
||||
ibutton_key_set_data(worker->key_p, worker->key_data, ibutton_key_get_max_size());
|
||||
result = true;
|
||||
break;
|
||||
case iButtonProtocolMetakom:
|
||||
furi_check(worker->key_p != NULL);
|
||||
ibutton_key_set_type(worker->key_p, iButtonKeyMetakom);
|
||||
ibutton_key_set_data(worker->key_p, worker->key_data, ibutton_key_get_max_size());
|
||||
result = true;
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
furi_hal_rfid_comp_stop();
|
||||
furi_hal_rfid_comp_set_callback(NULL, NULL);
|
||||
furi_hal_rfid_pins_reset();
|
||||
|
||||
furi_stream_buffer_free(read_context.stream);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
bool ibutton_worker_read_dallas(iButtonWorker* worker) {
|
||||
bool result = false;
|
||||
onewire_host_start(worker->host);
|
||||
furi_delay_ms(100);
|
||||
FURI_CRITICAL_ENTER();
|
||||
if(onewire_host_search(worker->host, worker->key_data, NORMAL_SEARCH)) {
|
||||
onewire_host_reset_search(worker->host);
|
||||
|
||||
// key found, verify
|
||||
if(onewire_host_reset(worker->host)) {
|
||||
onewire_host_write(worker->host, DS1990_CMD_READ_ROM);
|
||||
bool key_valid = true;
|
||||
for(uint8_t i = 0; i < ibutton_key_get_max_size(); i++) {
|
||||
if(onewire_host_read(worker->host) != worker->key_data[i]) {
|
||||
key_valid = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if(key_valid) {
|
||||
result = true;
|
||||
|
||||
furi_check(worker->key_p != NULL);
|
||||
ibutton_key_set_type(worker->key_p, iButtonKeyDS1990);
|
||||
ibutton_key_set_data(worker->key_p, worker->key_data, ibutton_key_get_max_size());
|
||||
}
|
||||
}
|
||||
} else {
|
||||
onewire_host_reset_search(worker->host);
|
||||
}
|
||||
onewire_host_stop(worker->host);
|
||||
FURI_CRITICAL_EXIT();
|
||||
return result;
|
||||
}
|
||||
|
||||
void ibutton_worker_mode_read_start(iButtonWorker* worker) {
|
||||
UNUSED(worker);
|
||||
furi_hal_power_enable_otg();
|
||||
}
|
||||
|
||||
void ibutton_worker_mode_read_tick(iButtonWorker* worker) {
|
||||
bool valid = false;
|
||||
if(ibutton_worker_read_dallas(worker)) {
|
||||
valid = true;
|
||||
} else if(ibutton_worker_read_comparator(worker)) {
|
||||
valid = true;
|
||||
}
|
||||
|
||||
if(valid) {
|
||||
if(ibutton_protocols_read(worker->protocols, worker->key)) {
|
||||
if(worker->read_cb != NULL) {
|
||||
worker->read_cb(worker->cb_ctx);
|
||||
}
|
||||
|
||||
ibutton_worker_switch_mode(worker, iButtonWorkerIdle);
|
||||
ibutton_worker_switch_mode(worker, iButtonWorkerModeIdle);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -208,83 +94,14 @@ void ibutton_worker_mode_read_stop(iButtonWorker* worker) {
|
||||
}
|
||||
|
||||
/*********************** EMULATE ***********************/
|
||||
static void onewire_slave_callback(void* context) {
|
||||
furi_assert(context);
|
||||
iButtonWorker* worker = context;
|
||||
ibutton_worker_notify_emulate(worker);
|
||||
}
|
||||
|
||||
void ibutton_worker_emulate_dallas_start(iButtonWorker* worker) {
|
||||
uint8_t* device_id = onewire_device_get_id_p(worker->device);
|
||||
const uint8_t* key_id = ibutton_key_get_data_p(worker->key_p);
|
||||
const uint8_t key_size = ibutton_key_get_max_size();
|
||||
memcpy(device_id, key_id, key_size);
|
||||
|
||||
onewire_slave_attach(worker->slave, worker->device);
|
||||
onewire_slave_set_result_callback(worker->slave, onewire_slave_callback, worker);
|
||||
onewire_slave_start(worker->slave);
|
||||
}
|
||||
|
||||
void ibutton_worker_emulate_dallas_stop(iButtonWorker* worker) {
|
||||
onewire_slave_stop(worker->slave);
|
||||
onewire_slave_detach(worker->slave);
|
||||
}
|
||||
|
||||
void ibutton_worker_emulate_timer_cb(void* context) {
|
||||
furi_assert(context);
|
||||
iButtonWorker* worker = context;
|
||||
|
||||
const LevelDuration level_duration =
|
||||
protocol_dict_encoder_yield(worker->protocols, worker->protocol_to_encode);
|
||||
|
||||
furi_hal_ibutton_emulate_set_next(level_duration_get_duration(level_duration));
|
||||
furi_hal_ibutton_pin_write(level_duration_get_level(level_duration));
|
||||
}
|
||||
|
||||
void ibutton_worker_emulate_timer_start(iButtonWorker* worker) {
|
||||
furi_assert(worker->key_p);
|
||||
const uint8_t* key_id = ibutton_key_get_data_p(worker->key_p);
|
||||
const uint8_t key_size = ibutton_key_get_max_size();
|
||||
|
||||
switch(ibutton_key_get_type(worker->key_p)) {
|
||||
case iButtonKeyDS1990:
|
||||
return;
|
||||
break;
|
||||
case iButtonKeyCyfral:
|
||||
worker->protocol_to_encode = iButtonProtocolCyfral;
|
||||
break;
|
||||
case iButtonKeyMetakom:
|
||||
worker->protocol_to_encode = iButtonProtocolMetakom;
|
||||
break;
|
||||
}
|
||||
|
||||
protocol_dict_set_data(worker->protocols, worker->protocol_to_encode, key_id, key_size);
|
||||
protocol_dict_encoder_start(worker->protocols, worker->protocol_to_encode);
|
||||
|
||||
furi_hal_ibutton_pin_configure();
|
||||
furi_hal_ibutton_emulate_start(0, ibutton_worker_emulate_timer_cb, worker);
|
||||
}
|
||||
|
||||
void ibutton_worker_emulate_timer_stop(iButtonWorker* worker) {
|
||||
UNUSED(worker);
|
||||
furi_hal_ibutton_emulate_stop();
|
||||
}
|
||||
|
||||
void ibutton_worker_mode_emulate_start(iButtonWorker* worker) {
|
||||
furi_assert(worker->key_p);
|
||||
furi_assert(worker->key);
|
||||
|
||||
furi_hal_rfid_pins_reset();
|
||||
furi_hal_rfid_pin_pull_pulldown();
|
||||
|
||||
switch(ibutton_key_get_type(worker->key_p)) {
|
||||
case iButtonKeyDS1990:
|
||||
ibutton_worker_emulate_dallas_start(worker);
|
||||
break;
|
||||
case iButtonKeyCyfral:
|
||||
case iButtonKeyMetakom:
|
||||
ibutton_worker_emulate_timer_start(worker);
|
||||
break;
|
||||
}
|
||||
ibutton_protocols_emulate_start(worker->protocols, worker->key);
|
||||
}
|
||||
|
||||
void ibutton_worker_mode_emulate_tick(iButtonWorker* worker) {
|
||||
@@ -292,56 +109,45 @@ void ibutton_worker_mode_emulate_tick(iButtonWorker* worker) {
|
||||
}
|
||||
|
||||
void ibutton_worker_mode_emulate_stop(iButtonWorker* worker) {
|
||||
furi_assert(worker->key_p);
|
||||
furi_assert(worker->key);
|
||||
|
||||
ibutton_protocols_emulate_stop(worker->protocols, worker->key);
|
||||
|
||||
furi_hal_rfid_pins_reset();
|
||||
|
||||
switch(ibutton_key_get_type(worker->key_p)) {
|
||||
case iButtonKeyDS1990:
|
||||
ibutton_worker_emulate_dallas_stop(worker);
|
||||
break;
|
||||
case iButtonKeyCyfral:
|
||||
case iButtonKeyMetakom:
|
||||
ibutton_worker_emulate_timer_stop(worker);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/*********************** WRITE ***********************/
|
||||
|
||||
void ibutton_worker_mode_write_start(iButtonWorker* worker) {
|
||||
void ibutton_worker_mode_write_common_start(iButtonWorker* worker) { //-V524
|
||||
UNUSED(worker);
|
||||
furi_hal_power_enable_otg();
|
||||
onewire_host_start(worker->host);
|
||||
}
|
||||
|
||||
void ibutton_worker_mode_write_tick(iButtonWorker* worker) {
|
||||
furi_check(worker->key_p != NULL);
|
||||
iButtonWriterResult writer_result = ibutton_writer_write(worker->writer, worker->key_p);
|
||||
iButtonWorkerWriteResult result;
|
||||
switch(writer_result) {
|
||||
case iButtonWriterOK:
|
||||
result = iButtonWorkerWriteOK;
|
||||
break;
|
||||
case iButtonWriterSameKey:
|
||||
result = iButtonWorkerWriteSameKey;
|
||||
break;
|
||||
case iButtonWriterNoDetect:
|
||||
result = iButtonWorkerWriteNoDetect;
|
||||
break;
|
||||
case iButtonWriterCannotWrite:
|
||||
result = iButtonWorkerWriteCannotWrite;
|
||||
break;
|
||||
default:
|
||||
result = iButtonWorkerWriteNoDetect;
|
||||
break;
|
||||
}
|
||||
void ibutton_worker_mode_write_blank_tick(iButtonWorker* worker) {
|
||||
furi_assert(worker->key);
|
||||
|
||||
const bool success = ibutton_protocols_write_blank(worker->protocols, worker->key);
|
||||
// TODO: pass a proper result to the callback
|
||||
const iButtonWorkerWriteResult result = success ? iButtonWorkerWriteOK :
|
||||
iButtonWorkerWriteNoDetect;
|
||||
if(worker->write_cb != NULL) {
|
||||
worker->write_cb(worker->cb_ctx, result);
|
||||
}
|
||||
}
|
||||
|
||||
void ibutton_worker_mode_write_stop(iButtonWorker* worker) {
|
||||
furi_hal_power_disable_otg();
|
||||
onewire_host_stop(worker->host);
|
||||
void ibutton_worker_mode_write_copy_tick(iButtonWorker* worker) {
|
||||
furi_assert(worker->key);
|
||||
|
||||
const bool success = ibutton_protocols_write_copy(worker->protocols, worker->key);
|
||||
// TODO: pass a proper result to the callback
|
||||
const iButtonWorkerWriteResult result = success ? iButtonWorkerWriteOK :
|
||||
iButtonWorkerWriteNoDetect;
|
||||
if(worker->write_cb != NULL) {
|
||||
worker->write_cb(worker->cb_ctx, result);
|
||||
}
|
||||
}
|
||||
|
||||
void ibutton_worker_mode_write_common_stop(iButtonWorker* worker) { //-V524
|
||||
UNUSED(worker);
|
||||
furi_hal_power_disable_otg();
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user