freewili
  • Command Line Interfaces
    • fwi-serial command line interface
    • fwi-convert command line interface
  • Development
    • Initial setup
    • Running unit tests
    • Building documentation
    • VSCode setup
    • Dependencies
    • Installing VSCode
    • Installing recommended extensions in VSCode
  • Examples
    • Find all devices
    • Upload files
    • Device Settings
    • FPGA Configuration
    • Toggle IO
    • Read Buttons
    • Set Board LEDs
    • SparkFun 9DoF IMU Breakout - ISM330DHCX, MMC5983MA (Qwiic)
    • Event Handling (Console)
    • Event Handling (GUI)
    • Audio Recording
    • Audio Playback - Tone
    • Audio Playback - Number
    • Audio Playback - Assets
    • IR Communication - Send
    • IR Communication - Read
    • UART Communication
    • SPI Communication
    • Filesystem Explorer
  • API Reference
    • fw
      • FileMap
        • FileMap.description
        • FileMap.directory
        • FileMap.extension
        • FileMap.from_ext()
        • FileMap.from_fname()
        • FileMap.processor
        • FileMap.to_path()
      • FreeWili
        • FreeWili.change_directory()
        • FreeWili.close()
        • FreeWili.create_blank_file()
        • FreeWili.create_directory()
        • FreeWili.display
        • FreeWili.display_serial
        • FreeWili.enable_accel_events()
        • FreeWili.enable_audio_events()
        • FreeWili.enable_battery_events()
        • FreeWili.enable_button_events()
        • FreeWili.enable_gpio_events()
        • FreeWili.enable_ir_events()
        • FreeWili.enable_radio_events()
        • FreeWili.enable_uart_events()
        • FreeWili.esp32
        • FreeWili.find_all()
        • FreeWili.find_first()
        • FreeWili.format_filesystem()
        • FreeWili.ftdi
        • FreeWili.get_file()
        • FreeWili.get_io()
        • FreeWili.get_rtc()
        • FreeWili.get_serial_from()
        • FreeWili.get_usb_device()
        • FreeWili.list_current_directory()
        • FreeWili.load_fpga_from_file()
        • FreeWili.main
        • FreeWili.main_serial
        • FreeWili.move_directory_or_file()
        • FreeWili.open()
        • FreeWili.play_audio_asset()
        • FreeWili.play_audio_file()
        • FreeWili.play_audio_number_as_speech()
        • FreeWili.play_audio_tone()
        • FreeWili.poll_i2c()
        • FreeWili.process_events()
        • FreeWili.read_all_buttons()
        • FreeWili.read_i2c()
        • FreeWili.read_write_spi_data()
        • FreeWili.record_audio()
        • FreeWili.remove_directory_or_file()
        • FreeWili.reset_display()
        • FreeWili.reset_to_uf2_bootloader()
        • FreeWili.run_script()
        • FreeWili.select_radio()
        • FreeWili.send_file()
        • FreeWili.send_ir()
        • FreeWili.set_board_leds()
        • FreeWili.set_event_callback()
        • FreeWili.set_io()
        • FreeWili.set_radio_event_rssi_threshold()
        • FreeWili.set_radio_event_sample_window()
        • FreeWili.set_rtc()
        • FreeWili.set_settings_as_startup()
        • FreeWili.set_settings_to_default()
        • FreeWili.set_system_sounds()
        • FreeWili.show_gui_image()
        • FreeWili.show_text_display()
        • FreeWili.stay_open
        • FreeWili.toggle_high_speed_io()
        • FreeWili.transmit_radio_subfile()
        • FreeWili.usb_devices
        • FreeWili.write_i2c()
        • FreeWili.write_radio()
        • FreeWili.write_uart()
    • framing
      • ResponseFrame
        • ResponseFrame.from_raw()
        • ResponseFrame.is_frame()
        • ResponseFrame.is_ok()
        • ResponseFrame.is_start_of_frame()
        • ResponseFrame.response
        • ResponseFrame.response_as_bytes()
        • ResponseFrame.rf_type
        • ResponseFrame.rf_type_data
        • ResponseFrame.seq_number
        • ResponseFrame.success
        • ResponseFrame.timestamp
        • ResponseFrame.timestamp_as_datetime()
      • ResponseFrameType
        • ResponseFrameType.Event
        • ResponseFrameType.Standard
    • image
      • convert()
      • Image Example
    • types
      • AccelData
        • AccelData.from_string()
        • AccelData.g
        • AccelData.temp_c
        • AccelData.temp_f
        • AccelData.x
        • AccelData.y
        • AccelData.z
      • AudioData
        • AudioData.data
        • AudioData.from_string()
      • BatteryData
        • BatteryData.charge_complete
        • BatteryData.charging
        • BatteryData.from_string()
        • BatteryData.ichg
        • BatteryData.vbatt
        • BatteryData.vbus
        • BatteryData.vsys
      • ButtonColor
        • ButtonColor.Blue
        • ButtonColor.Green
        • ButtonColor.Red
        • ButtonColor.Unknown
        • ButtonColor.White
        • ButtonColor.Yellow
      • ButtonData
        • ButtonData.blue
        • ButtonData.from_string()
        • ButtonData.gray
        • ButtonData.green
        • ButtonData.red
        • ButtonData.yellow
      • EventData
        • EventData.from_string()
      • EventType
        • EventType.Accel
        • EventType.Audio
        • EventType.Battery
        • EventType.Button
        • EventType.File
        • EventType.GPIO
        • EventType.IR
        • EventType.Radio1
        • EventType.Radio2
        • EventType.UART1
        • EventType.Unknown
        • EventType.from_frame()
        • EventType.from_string()
        • EventType.get_data_type()
      • FileSystemContents
        • FileSystemContents.contents
        • FileSystemContents.cwd
      • FileSystemItem
        • FileSystemItem.file_type
        • FileSystemItem.name
        • FileSystemItem.size
      • FileType
        • FileType.Directory
        • FileType.File
        • FileType.Unknown
        • FileType.from_string()
      • FreeWiliProcessorType
        • FreeWiliProcessorType.Display
        • FreeWiliProcessorType.ESP32
        • FreeWiliProcessorType.FTDI
        • FreeWiliProcessorType.Main
        • FreeWiliProcessorType.Unknown
      • GPIOData
        • GPIOData.from_string()
        • GPIOData.pin
        • GPIOData.raw
      • IOMenuCommand
        • IOMenuCommand.Get
        • IOMenuCommand.High
        • IOMenuCommand.Low
        • IOMenuCommand.Pwm
        • IOMenuCommand.Stream
        • IOMenuCommand.Toggle
        • IOMenuCommand.from_string()
        • IOMenuCommand.menu_character
      • IRData
        • IRData.from_string()
        • IRData.value
      • Radio1Data
        • Radio1Data.data
        • Radio1Data.from_string()
        • Radio1Data.raw
      • Radio2Data
      • RawData
        • RawData.from_string()
        • RawData.value
      • UART1Data
freewili
  • Search


© Copyright 2025, Free-Wili.

Built with Sphinx using a theme provided by Read the Docs.