UHF-RFID Unit

Support the following products:

Micropython Example:

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from unit import UHFRFIDUnit


nbiot2_0 = None
uhfrfid_0 = None


epc = None


def setup():
    global nbiot2_0, uhfrfid_0, epc

    M5.begin()
    Widgets.fillScreen(0x222222)

    uhfrfid_0 = UHFRFIDUnit(2, port=(18, 17))
    epc = uhfrfid_0.inventory()
    print(epc)
    uhfrfid_0.select(UHFRFIDUnit.S0, 0b000, UHFRFIDUnit.RFU, 0x20, False, epc)
    uhfrfid_0.write_mem_bank(UHFRFIDUnit.RFU, 0x00, "12345678", "00000000")
    print(uhfrfid_0.read_mem_bank(UHFRFIDUnit.RFU, 0x00, 4, "00000000"))


def loop():
    global nbiot2_0, uhfrfid_0, epc
    M5.update()


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

UIFLOW2 Example:

cores3_uhf_rfid_example.m5f2

class UHFRFIDUnit

Constructors

class UHFRFIDUnit(id: Literal[0, 1, 2], port: list | tuple, verbose: bool = False)

Create a UHF-RFID unit.

Parameters:

id (int) – The ID of the unit.
port (list|tuple) – The port that the unit is connected to.
verbose (bool) – Print the log information. Default is True.

UIFLOW2:

Methods

Demodulator

UHFRFIDUnit.get_demodulator_mixer() → int

Get demodulator mixer value.

Return int:: demodulator mixer value.

Options:

0x00: 0dB
0x01: 3dB
0x02: 6dB
0x03: 9dB
0x04: 12dB
0x05: 15dB
0x06: 16dB

UIFLOW2:

UHFRFIDUnit.set_demodulator_mixer(value: int) → bool

Set demodulator mixer value.

Parameters:: value (int) – demodulator mixer value.

Options:

0x00: 0dB
0x01: 3dB
0x02: 6dB
0x03: 9dB
0x04: 12dB
0x05: 15dB
0x06: 16dB

Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.get_demodulator_amplifier() → int

Get demodulator amplifier value.

Return int:: demodulator amplifier value.

Options:

0x00: 12dB
0x01: 18dB
0x02: 21dB
0x03: 24dB
0x04: 27dB
0x05: 30dB
0x06: 36dB
0x07: 40dB

UIFLOW2:

UHFRFIDUnit.set_demodulator_amplifier(value: int) → bool

Set demodulator amplifier value.

Parameters:: value (int) – demodulator amplifier value.

Options:

0x00: 12dB
0x01: 18dB
0x02: 21dB
0x03: 24dB
0x04: 27dB
0x05: 30dB
0x06: 36dB
0x07: 40dB

Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.get_demodulator_threshold() → int

Get demodulator threshold value.

Return int:: demodulator threshold value. the range is from 0x01B0 to 0xFFFF.

UIFLOW2:

UHFRFIDUnit.set_demodulator_threshold(value: int) → bool

Set demodulator threshold value.

Parameters:: value (int) – demodulator threshold value. the range is from 0x01B0 to 0xFFFF.
Return bool:: True if success, False if failed.

UIFLOW2:

Working

UHFRFIDUnit.get_working_region() → int

Get work region.

Return int:: work region.

Options:

UHFRFIDUnit.CN_900MHZ: China 900MHz
UHFRFIDUnit.CN_800MHZ: China 800MHz
UHFRFIDUnit.USA: USA
UHFRFIDUnit.EUR: EUR
UHFRFIDUnit.KR: KR

UIFLOW2:

UHFRFIDUnit.set_working_region(region: int) → bool

Set work region.

Parameters:: region (int) – work region.

Options:

UHFRFIDUnit.CN_900MHZ: China 900MHz
UHFRFIDUnit.CN_800MHZ: China 800MHz
UHFRFIDUnit.USA: USA
UHFRFIDUnit.EUR: EUR
UHFRFIDUnit.KR: KR

Return int:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.get_working_channel() → int

Get work channel.

Return int:: work channel. the range is from 0 to 19.

UIFLOW2:

UHFRFIDUnit.set_working_channel(channel: int) → bool

Set work channel.

Parameters:: channel (int) – work channel. the range is from 0 to 19.
Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.insert_working_channel(channel: int) → bool

Insert work channel.

Parameters:: channel (int) – work channel. the range is from 0 to 19.
Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.clear_working_channel() → bool

Clear work channel.

Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.set_automatic_hopping(enable: bool) → bool

Set automatic hopping.

Parameters:: enable (bool) – enable automatic hopping.
Return bool:: True if success, False if failed.

UIFLOW2:

RF Power

UHFRFIDUnit.get_channel_rssi(channel: int) → int

Get channel RSSI value.

Parameters:: channel (int) – work channel. the range is from 0 to 19.
Return int:: channel RSSI value. the unit is dBm.

UIFLOW2:

UHFRFIDUnit.get_blocking_signal_strength(channel: int) → int

Get blocking signal strength.

Parameters:: channel (int) – work channel. the range is from 0 to 19.
Return int:: blocking signal strength. the unit is dBm.

UIFLOW2:

UHFRFIDUnit.get_tx_power() → int

Get TX power.

Return int:: TX power. the unit is dBm. the range is from -7dBm to 30dBm.

UIFLOW2:

UHFRFIDUnit.set_tx_power(power: int) → bool

Set TX power.

Parameters:: power (int) – TX power. the range is from -7dBm to 30dBm.
Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.set_continuous_wave(enable: bool) → bool

Set continuous wave.

Parameters:: enable (bool) – enable continuous wave.
Return bool:: True if success, False if failed.

UIFLOW2:

Module Information and Settings

UHFRFIDUnit.get_manufacturer_id() → str

Get manufacturer ID.

Return str:: manufacturer ID.

UIFLOW2:

UHFRFIDUnit.get_hardware_version() → str

Get hardware version.

Return str:: hardware version.

UIFLOW2:

UHFRFIDUnit.get_firmware_version() → str

Get firmware version.

Return str:: firmware version.

UIFLOW2:

UHFRFIDUnit.sleep() → bool

Set sleep.

Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.wake() → bool

Set wake up.

Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.set_automatic_sleep_time(min: int) → bool

Set automatic sleep time.

Parameters:: min (int) – automatic sleep time in minutes. the range is from 1 to 30.
Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.disable_automatic_sleep() → bool

Disable automatic sleep.

Return bool:: True if success, False if failed.

UIFLOW2:

Read and Write Tag

UHFRFIDUnit.inventory() → str

Get tag epc code. if no tag is found, return empty string.

Returns:: hexadecimal string of tag epc code.

UIFLOW2:

UHFRFIDUnit.set_select_mode(mode: int) → bool

Set select mode.

Parameters:: mode (int) – select mode.

Options:

0x00: need select command
0x01: no need select command
0x02: part operation need select command

Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.select(target: int, action: int, membank: int, pointer: int, truncate: bool, mask: str) → bool

Set select tag.

Parameters:

target (int) – target.
action (int) – action.
membank (int) – memory bank.
pointer (int) – pointer.
truncate (bool) – truncate.
mask (str) – EPC code. hexadecimal string.

Return bool:

True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.set_access_password(old_password: str, new_password: str) → None

Set access password.

Parameters:

old_password (str) – old access password. hexadecimal string.
new_password (str) – new access password. hexadecimal string.

UIFLOW2:

UHFRFIDUnit.set_kill_password(password) → None

Set kill password.

Parameters:: password (str) – kill password. hexadecimal string.

UIFLOW2:

UHFRFIDUnit.kill(password: str) → bool

Kill tag.

Parameters:: password (str) – kill password. hexadecimal string.
Return bool:: True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.set_query_param(dr=0b0, m=0b00, tr_ext=0b1, sel=0b00, session=0b00, target=0b0, q=0b0100) → bool

Set query parameter.

Parameters:

dr (int) – dr. fixed to 0.
m (int) –
1. fixed to 0.
tr_ext (int) – tr_ext. fixed to 1.
sel (int) – sel. the range is from 0 to 3.
session (int) – session. the range is from 0 to 3.
target (int) – target. the range is from 0 to 1.
q (int) –
1. the range is from 0 to 8.

Return bool:

True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.lock_mem_bank(kill_lock: int = 0b00, access_lock: int = 0b00, epc_lock: int = 0b00, tid_lock: int = 0b00, user_lock: int = 0b00, access: str = '00000000') → bool

Lock memory bank.

Parameters:

kill_lock (int) –
kill lock.
Options:
- UHFRFIDUnit.OPEN: open
- UHFRFIDUnit.LOCK: lock
- UHFRFIDUnit.PERMA_OPEN: perma open
- UHFRFIDUnit.PERMA_LOCK: perma lock
access_lock (int) –
access lock.
Options:
- UHFRFIDUnit.OPEN: open
- UHFRFIDUnit.LOCK: lock
- UHFRFIDUnit.PERMA_OPEN: perma open
- UHFRFIDUnit.PERMA_LOCK: perma lock
epc_lock (int) –
epc lock.
Options:
- UHFRFIDUnit.OPEN: open
- UHFRFIDUnit.LOCK: lock
- UHFRFIDUnit.PERMA_OPEN: perma open
- UHFRFIDUnit.PERMA_LOCK: perma lock
tid_lock (int) –
tid lock.
Options:
- UHFRFIDUnit.OPEN: open
- UHFRFIDUnit.LOCK: lock
- UHFRFIDUnit.PERMA_OPEN: perma open
- UHFRFIDUnit.PERMA_LOCK: perma lock
user_lock (int) –
user lock.
Options:
- UHFRFIDUnit.OPEN: open
- UHFRFIDUnit.LOCK: lock
- UHFRFIDUnit.PERMA_OPEN: perma open
- UHFRFIDUnit.PERMA_LOCK: perma lock
access (str) – access password. hexadecimal string.

UIFLOW2:

UHFRFIDUnit.read_mem_bank(bank: int, offset: int, length: int, access_password: str = '00000000') → str

Read memory bank.

Parameters:

bank (int) –
memory bank.
Options:
- UHFRFIDUnit.RFU: reserved
- UHFRFIDUnit.EPC: epc
- UHFRFIDUnit.TID: tid
- UHFRFIDUnit.USER: user
offset (int) – offset.
length (int) – length.
access_password (str) – access password. hexadecimal string.

Return str:

data. hexadecimal string.

UIFLOW2:

UHFRFIDUnit.write_mem_bank(bank: int, offset: int, data: str, access_password: str = '00000000')

Write memory bank.

Parameters:

bank (int) –
memory bank.
Options:
- UHFRFIDUnit.RFU: reserved
- UHFRFIDUnit.EPC: epc
- UHFRFIDUnit.TID: tid
- UHFRFIDUnit.USER: user
offset (int) – offset.
data (str) – data. hexadecimal string.
access_password (str) – access password. hexadecimal string.

UIFLOW2:

Impinj Monza

UHFRFIDUnit.get_impinj_monza_qt_sr(persistence, password: str = '00000000') → bool

Get Impinj Monza QT_SR.

Parameters:

persistence (int) – persistence. 0x00 is volatile memory, 0x01 is non-volatile memory.
password (str) – access password. hexadecimal string.

Return bool:

QT_SR status.

UIFLOW2:

UHFRFIDUnit.set_impinj_monza_qt_sr(qt_sr: bool, persistence: int, password: str = '00000000') → bool

Set Impinj Monza QT_SR.

Parameters:

qt_sr (bool) – QT_SR status.
persistence (int) – persistence. 0x00 is volatile memory, 0x01 is non-volatile memory.
password (str) – access password. hexadecimal string.

Return bool:

True if success, False if failed.

UIFLOW2:

UHFRFIDUnit.get_impinj_monza_qt_mem(persistence, password: str = '00000000') → bool

Set Impinj Monza QT_MEM.

Parameters:

persistence (int) – persistence. 0x00 is volatile memory, 0x01 is non-volatile memory.
password (str) – access password. hexadecimal string.

Return bool:

QT_MEM status.

UIFLOW2:

UHFRFIDUnit.set_impinj_monza_qt_mem(qt_mem: bool, persistence: int, password: str = '00000000') → bool

Set Impinj Monza QT_MEM.

Parameters:

qt_mem (bool) – QT_MEM status.
persistence (int) – persistence. 0x00 is volatile memory, 0x01 is non-volatile memory.
password (str) – access password. hexadecimal string.

Return bool: