• Docs
    • Tibbo BASIC/C
    • Programmable Hardware
    • Serial-over-IP

Tibbo

  • The Foreword
  • How to Use This Manual
    • Common vs. Proprietary Knowledge
  • T H E G U I D E
    • The Introduction
      • Programmable Devices
      • Tibbo Operating System (TiOS)
      • Tibbo IDE (TIDE) Software
      • The Device Explorer Utility
      • Tibbo BASIC and Tibbo C
      • Platforms, Syscalls, and Objects
      • Libraries
      • Status LEDs and MD Button
      • TiOS Simulator
    • Your First Project
      • Preparing
      • Starting a New Project
      • Writing Code
      • Building, Uploading, Running
      • Testing
      • Debugging
      • Compiling a Final Binary
    • Tibbo IDE (TIDE) Software
      • Working With TIDE Projects
        • Adding Files, Understanding Base Locations
        • File Types
        • Conditional Compilation
      • Project Parser and Browser
        • Quick Info Tooltips
      • Compiling, Uploading, Running
      • Debugging
        • Target States, Exceptions
      • Releasing Your Application
    • Tibbo BASIC/C
      • Simple Source Code Examples
      • Identifiers (Names), Case Sensitivity
      • Operators
      • Variables, Pointers, Constants, Scopes
        • Simple Variable Types
          • Type Conversion
          • Difference Between 16- and 32-bit Platforms
        • String Type and Pointers
        • Arrays, Structures, Unions
          • Limitations on the Use of Strings in Unions
          • Bitfield Structures
          • Copying between Arrays, Structures, and Unions
          • Conversion to/from Strings
        • Constants and Variable Initialization
        • Enumeration Types
          • Type Mapping for Enums
        • Platform- and User-defined Types
        • Scopes
        • Sizeof and Countof
      • Procedures and Event Handlers
        • Cross-calling Basic and C Procedures
        • Memory Allocation
      • Objects and Syscalls
      • Control Structures
      • Working With HTML
      • Doevents
        • Memory Allocation With Doevents
        • Call Chain Limitations With Doevents
      • Using Preprocessor
        • The Scope of Preprocessor Directives
  • T H E R E F E R E N C E
    • Tibbo BASIC Keywords
    • Tibbo C Keywords
    • Tibbo IDE (TIDE) Software
      • Dialogs
        • New Project Dialog
        • Add New File to Project Dialog
        • Add Existing File to Project Dialog
        • Change File Type Dialog
        • File Condition Dialog
        • Project Settings Dialog
        • Customize Project Dialog
        • Device Explorer (Select/Manage Target)
          • When You Can't See Your Target
      • Panes
        • Files
        • Browser-Project Pane
        • Browser-File Pane
        • Output Pane
        • Watch Pane
        • Locals Pane
        • Call Stack Pane
        • Breakpoints Pane
        • Bookmarks Pane
      • Language Element Icons
    • Platforms
      • SIMULATOR
        • The Simulator Window
        • Network Communications on the Simulator
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_sock_interfaces
        • Simulator Objects
          • Beep Object
          • Button Object
          • FD Object
          • Kp Object
          • LCD Object
          • Net Object
          • Pat Object
          • Romfile Object
          • RTC Object
          • Sock Object
          • Stor Object
          • Sys Object
      • EM500W
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
        • Connecting External Flash IC
      • EM510W
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
        • Connecting External Flash IC
      • EM1000, EM1000W, and EM1000N Platforms
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • EM1001, EM1001W, and EM1001N Platforms
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • EM1202, EM1202W, and EM1202N Platforms
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • EM1206, EM1206W, and EM1206N Platforms
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • EM2000W
        • Platform-specific Constants
          • Enum pl_adc_num
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
        • Working with the LCD
      • WM2000
        • Dual Tibbo BASIC/C Apps
        • Updated Platform Objects
        • Platform-specific Constants
      • DS1100 Platform
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • DS1101W and DS1101N Platforms
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • DS1102W and DS1102N Platform
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • WS1102 Platform
        • Dual Tibbo BASIC/C Apps
        • Updated Platform Objects
        • Platform-specific Constants
      • DS1202 Platform
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • DS1206 Platform
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
      • TPP2W and TPP2N
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
        • Working with the TPS2L LCD
        • Working with the TPS2L Keypad
        • LED Bar Control
      • TPP3W and TPP3N
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
        • Buzzer Initialization Code
        • LED Bar Control
      • TPP2W(G2)
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
        • Working with the TPS2L LCD
        • Working with the TPS2L Keypad
        • LED Bar Control
      • TPP3W(G2)
        • Platform-specific Constants
          • Enum pl_redir
          • Enum pl_io_num
          • Enum pl_io_port_num
          • Enum pl_int_num
          • Enum pl_sock_interfaces
          • Enum pl_adc_num
        • LED Bar Control
      • Common Information
        • Clock Frequency Control
        • GPIO Type
        • Serial Port FIFOs
        • Serial Port Line Configuration
        • Serial Port Interrupts and Io.intenabled
        • RTS/CTS Remapping
        • Connecting GA1000 and WA2000
        • Display Type Selection and Line Remapping
        • Special Configuration Section of the EEPROM
        • Device Serial Number
        • Flash Memory Configuration
        • Debug Communications
        • Supported Variable Types
        • Supported Functions
        • Setup (MD) Button (Line)
        • Status LEDs (LED Control Lines)
        • Monitor/Loader (M/L)
          • M/L Flowchart (All Devices Except WM2000)
          • M/L V4 Flowchart (WM2000)
          • Update Phases
            • XModem Serial Updates
              • TPS Devices
              • Programmable Serial Controllers
              • Programmable Boards and Modules
            • Network Updates
            • Bluetooth Low Energy (BLE) Updates
              • Using the Tibbo Updater Smartphone App
              • Using the BLE Firmware Updater Web App
          • Device Configuration Block (WM2000 Only)
            • BLE Console
            • Companion App
            • Configuration Reset
            • Wi-Fi Regulatory Domains
    • System Functions (Syscalls)
      • Aes128dec Function
      • Aes128enc Function
      • Asc Function
      • Bin Function
      • Cfloat Function
      • Chr Function
      • Date Function
      • Daycount Function
      • Ddstr Function
      • Ddval Function
      • Ftostr Function
      • Hex Function
      • Hours Function
      • Insert Function
      • Instr Function
      • Lbin Function
      • Left Function
      • Len Function
      • Lhex Function
      • Lstr Function
      • Lstri Function
      • Lval Function
      • Md5 Function
      • Mid Function
      • Mincount Function
      • Minutes Function
      • Month Function
      • Random Function
      • Rc4 Function
      • Right Function
      • Sha1 Function
      • Str Function
      • Strand Function
      • Strgen Function
      • Stri Function
      • Stror Function
      • Strsum Function
      • Strtof Function
      • Strxor Function
      • Val Function
      • Vali Function
      • Weekday Function
      • Year Function
    • Objects
      • Adc Object
        • .enabled Property
        • .getdata Method
        • .num Property
      • Beep Object
        • Properties, Methods, Events
          • .divider Property
          • .frequency Property
          • .play Method
          • on_beep Event
      • Bt Object
        • Overview
          • Bringing Up and Enabling the BLE Interface
            • Setting MAC Address (Optional)
            • A Bit More on Emulation Modes
          • Disabling BLE and Detecting Failures
          • Handling BLE Connections
          • Sending and Receiving Data
            • Allocating TX and RX Buffers
            • Receiving Data
            • Transmitting Data
            • Buffer Overruns and Data Loss
        • Properties, Methods, and Events
          • .advertise Property
          • .connected R/O Property
          • .disable Method
          • .disconnect Method
          • .emulation Property
          • .enable Method
          • .enabled R/O Property
          • .getdata Method
          • .mac R/O Property
          • .name Property
          • .newtxlen R/O Property
          • .notifysent Property
          • .peekdata Method
          • .rxbuffrq Method
          • .rxbuffsize R/O Property
          • .rxclear Method
          • .rxlen R/O Property
          • .send Method
          • .setdata Method
          • .txbuffrq Method
          • .txbuffsize R/O Property
          • .txclear Method
          • .txfree R/O Property
          • .txlen R/O Property
          • on_bt_data_arrival Event
          • on_bt_data_sent Event
          • on_bt_event Event
          • on_bt_overrun Event
      • Button Object
        • .Pressed R/O Property
        • .Time R/O Property
        • On_button_pressed Event
        • On_button_released Event
      • Fd Object
        • Overview
          • Sharing Flash Between Your Application and Data
          • Fd. Object's Status Codes
          • Direct Sector Access
            • Using Checksums
          • File-based Access
            • Formatting the Flash Disk
              • Disk Area Allocation Details
            • Mounting the Flash Disk
            • Checking Disk Vitals
            • File Names and Attributes
            • Creating, Deleting, and Renaming Files
            • Reading and Writing File Attributes
            • Walking Through File Directory
            • Opening Files
            • Writing To and Reading From Files
            • Removing Data From Files
            • Searching Within Files
            • Closing Files
            • Using Disk Transactions
              • Understanding Transaction Capacity
          • File-based and Direct Sector Access Coexistence
          • Self-upgrading the Firmware/Application
          • Prolonging Flash Memory Life
        • Properties and Methods
          • .Availableflashspace R/O Property
          • .Buffernum Property
          • .Capacity R/O Property
          • .Checksum Method
          • .Close Method
          • .Copyfirmware Method (Selected Platforms Only)
          • .Copyfirmwarefromfile Method (Selected Platforms Only)
          • .Copyfirmwarefromfilelzo Method (Selected Platforms Only)
          • .Copyfirmwarelzo Method, 16-bit version (Selected Platforms Only)
          • .Copyfirmwarelzo Method, 32-bit version Selected Platforms Only)
          • .Cutfromtop Method
          • .Create Method
          • .Delete Method
          • .Filenum Property
          • .Fileopened R/O Property
          • .Filesize R/O Property
          • .Find Method
          • .Flush Method
          • .Format Method
          • .Formatj Method
          • .Getattributes Method
          • .Getbuffer Method
          • .Getdata Method
          • .Getfreespace Method
          • .Getnextdirmember Method
          • .Getnumfiles Method
          • .Getsector Method
          • .Laststatus R/O Property
          • .Maxopenedfiles R/O Property
          • .Maxstoredfiles R/O Property
          • .Mount Method
          • .Numservicesectors R/O Property
          • .Open Method
          • .Pointer R/O Property
          • .Ready R/O Property
          • .Rename Method
          • .Resetdirpointer Method
          • .Sector R/O Property
          • .Setattributes Method
          • .Setbuffer Method
          • .Setdata Method
          • .Setfilesize Method
          • .Setsector Method
          • .Setpointer Method
          • .Totalsize R/O Property
          • .Transactioncapacityremaining R/O Property
          • .Transactioncommit Method
          • .Transactionstart Method
          • .Transactionstarted R/O Property
      • IO Object
        • Overview
          • Line/Port Manipulation With Pre-selection
          • Line/Port Manipulation Without Pre-selection
          • Controlling Output Buffers
          • Working With Interrupts
        • Properties, Events, Methods
          • .Enabled Property (Selected Platforms Only)
          • .Intenabled Property
          • .Intnum Property
          • .Invert Method
          • .Lineget Method
          • .Lineset Method
          • .Num Property
          • On_io_int Event
          • .Portenabled Property (Selected Platforms Only)
          • .Portget Method
          • .Portnum Property
          • .Portset Method
          • .Portstate property
          • .State Property
      • Kp Object
        • Connecting Matrix Keypads
        • Connecting Binary Keypads
        • Key States and Transitions
        • Preparing the Keypad for Operation
        • Key Codes
        • Receiving Keypad Events Through On_kp Event
        • Receiving Keypad Events Using Kp.getkey Method
        • Handling Keypad Buffer Overflows
        • Properties, Methods, Events
          • .Autodisablecodes Property
          • .Clearbuffer Method
          • .Enabled Property
          • .Genkpevent Property
          • .Getkey Method
          • .Idlecode Property
          • .Lockupdelay Property
          • .Longpressdelay Property
          • .Longreleasedelay Property
          • .Mode Property
          • .Overflow R/O Property
          • On_kp Event
          • On_kp_overflow Event
          • .Pressdelay Property
          • .Releasedelay Property
          • .Repeatdelay Property
          • .Returnlinesmapping Property
          • .Scanlinesmapping Property
      • LCD Object
        • Overview
          • Understanging Controller Properties
          • Preparing the Display for Operation
          • Working With Pixels and Colors
          • Lines, Rectangles, and Fills
          • Working With Text
            • Raster Font File Format
          • Displaying Images
          • Improving Graphical Performance
        • Supported Controllers/Panels
          • Samsung S6B0108 (Winstar WG12864F)
          • Solomon SSD1329 (Ritdisplay RGS13128096)
          • Himax HX8309 (Ampire AM176220)
          • Solomon SSD1963 (LCD-P0005)
        • Properties and Methods
          • .Backcolor Property
          • .Bitsperpixel R/O Property
          • .Bluebits R/O Property
          • .Bmp Method
          • .Enabled Property
          • .Error R/O Property
          • .Fill Method
          • .Filledrectangle Method
          • .Fontheight R/O Property
          • .Fontpixelpacking R/O Property
          • .Forecolor Property
          • .Getprintwidth Method
          • .Greenbits R/O Property
          • .Height Property
          • .Horline Method
          • .Inverted Property
          • .Iomapping Property
          • .Line Method
          • .Linewidth Property
          • .Lock Method
          • .Lockcount R/O Property
          • .Paneltype R/O Property
          • .Pixelpacking R/O Property
          • .Print Method
          • .Printaligned Method
          • .Rectangle Method
          • .Redbits R/O Property
          • .Rotated Property
          • .Setfont Method
          • .Setpixel Method
          • .Textalignment Property
          • .Texthorizontalspacing Property
          • .Textorientation Property
          • .Textverticalspacing Property
          • .Unlock Method
          • .Verline Method
          • .Width Property
      • Net Object
        • Overview
          • Main Parameters
          • Checking Ethernet Status
        • Properties, Methods, Events
          • .Mac R/O Property
          • .Ip Property
          • .Netmask Property
          • .Gatewayip Property
          • .Failure R/O Property
          • .Linkstate R/O Property
          • On_net_link_change Event
          • On_net_overrun Event
      • Pat Object
        • .Channel Property
        • .Greenmap Property
        • On_pat Event
        • .Play Method
        • .Redmap Property
      • Ppp Object
        • .Buffrq Method
        • .Buffsize R/O Property
        • .Enabled Property
        • .Ip Property
        • .Portnum Property
      • Pppoe Object [DEPRECATED FROM V4]
        • .Acmac Property
        • .Ip Property
        • .Sessionid Property
      • PWM Object
        • Properties, Methods
          • .dutycycle Property
          • .enabled Property
          • .frequency Property
          • .num Property
          • .update Method
          • .updateall Method
      • Romfile Object
        • .Find Method
        • .Find32 Method
        • .Getdata Method
        • .Offset R/O Property
        • .Open Method
        • .Pointer Property
        • .Pointer32 Property
        • .Size R/O Property
      • RTC Object
        • .Getdata Method (Previously .Get)
        • .Running R/O Property
        • .Setdata Method (Previously .Set)
      • Ser Object
        • Overview
          • Anatomy of a Serial Port
          • Three Modes of the Serial Port
            • UART Mode
            • Wiegand Mode
            • Clock/Data Mode
          • Port Selection
          • Serial Settings
          • Sending and Receiving Data (TX and RX buffers)
            • Allocating Memory for Buffers
            • Using Buffers
            • Buffer Memory Status
            • Receiving Data
            • Sending Data
            • Handling Buffer Overruns
            • Redirecting Buffers
            • Sinking Data
        • Properties, Methods, Events
          • .Autoclose Property
          • .Baudrate Property
          • .Baud Property
          • .Bits Property
          • .Ctsmap property (Selected Platforms Only)
          • .Dircontrol Property
          • .Div9600 R/O Property
          • .Enabled Property
          • .Escchar Property
          • .Esctype Property
          • .Flowcontrol Property
          • .Getdata Method
          • .Interchardelay Property
          • .Interface Property
          • .Mode Property
          • .Newtxlen R/O Property
          • .Notifysent Method
          • .Num Property
          • .Numofports R/O Property
          • On_ser_data_arrival Event
          • On_ser_data_sent Event
          • On_ser_esc Event
          • On_ser_overrun Event
          • .Parity Property
          • .Peekdata Method
          • .Redir Method
          • .Rtsmap Property (Selected Platforms Only)
          • .Rxbuffrq Method
          • .Rxbuffsize R/O Property
          • .Rxclear Method
          • .Rxlen R/O Property
          • .Send Method
          • .Setdata Method
          • .Sinkdata Property
          • .Txbuffrq Method
          • .Txbuffsize R/O Property
          • .Txclear Method
          • .Txfree R/O Property
          • .Txlen R/O Property
      • Sock Object
        • Overview
          • Anatomy of a Socket
          • Socket Selection
          • Handling Network Connections
            • TCP connection basics
            • UDP "connection" basics
            • Accepting Incoming Connections
            • Accepting UDP broadcasts
            • Understanding TCP Reconnects
            • Understanding UDP Reconnects and Port Switchover
            • Incoming Connections on Multiple Sockets
            • Establishing Outgoing Connections
            • Sending UDP broadcasts
            • Closing Connections
            • Checking Connection Status
            • More On the Socket's Asynchronous Nature
          • Sending and Receiving data
            • Allocating Memory for Buffers
            • Using Buffers in TCP Mode
            • Using Buffers in UDP Mode
            • TX and RX Buffer Memory Status
            • Receiving Data in TCP Mode
            • Receiving Data in UDP Mode
            • Sending TCP and UDP Data
            • "Split Packet" Mode of TCP Data Processing
            • Handling Buffer Overruns
            • Redirecting Buffers
            • Sinking Data
          • Working With Inband Commands
            • Inband Message Format
            • Inband-related Buffers (CMD, RPL, and TX2)
            • Processing Inband Commands
            • Sending Inband Replies
          • Using HTTP
            • HTTP-related Buffers
            • Setting the Socket for HTTP
            • Socket Behavior in the HTTP Mode
            • Including BASIC Code in HTTP Files
            • Generating Dynamic HTML Pages
            • URL Substitution
            • Working with HTTP Variables
              • Simple Case (Small Amount of Variable Data)
              • Complex Case (Large Amount of Variable Data)
              • Details on Variable Data
          • Transport Layer Security (TLS)
            • Obtaining an Encryption Certificate
            • TLS Buffer Allocation
            • Establishing a Secure Connection
            • Sending and Receiving Data
            • Closing Secure Connections
            • Simple, Secure HTTP Requests
        • Properties, Methods, and Events
          • .acceptbcast Property
          • .allowedinterfaces Property
          • .availableinterfaces R/O Property
          • .bcast R/O Property
          • .close Method
          • .cmdbuffrq Method
          • .cmdbuffsize R/O Property (32-bit Platforms Only)
          • .cmdlen R/O Property
          • .connect Method
          • .connectiontout Property
          • .currentinterface R/O Property
          • .discard Method
          • .endchar Property
          • .escchar Property
          • .event R/O Property (Obsolete)
          • .eventsimple R/O Property (Obsolete)
          • .getdata Method
          • .gethttprqstring Method
          • .getinband Method
          • .httpmode Property
          • .httpnoclose Property
          • .httpportlist Property
          • .httprqstring R/O Property
          • .httprqtype R/O Property
          • .inbandcommands Property
          • .inconenabledmaster Property
          • .inconmode Property
          • .localport R/O Property
          • .localportlist Property
          • .newtxlen R/O Property
          • .nextpacket Method
          • .notifysent Method
          • .num Property
          • .numofsock R/O Property
          • .outport Property
          • .peekdata Method
          • .protocol Property
          • .reconmode Property
          • .redir Method
          • .remoteip R/O Property
          • .remotemac R/O Property
          • .remoteport R/O Property
          • .reset Method
          • .rplbuffrq Method
          • .rplbuffsize R/O Property (32-bit Platforms Only)
          • .rplfree R/O Property
          • .rpllen R/O Property
          • .rxbuffrq Method
          • .rxbuffsize R/O Property
          • .rxclear Method
          • .rxlen R/O Property
          • .rxpacketlen R/O Property
          • .send Method
          • .setdata Method
          • .setsendinband Method
          • .sinkdata Property
          • .splittcppackets Property
          • .state R/O Property
          • .statesimple R/O Property
          • .targetbcast Property
          • .targetinterface Property
          • .targetip Property
          • .targetport Property
          • .tlsbuffrq Method
          • .tlscurrentnum R/O Property
          • .tlsdeinit Method
          • .tlsgetdata Method
          • .tlshandshake Method
          • .tlsinit Method
          • .tlspeekdata Method
          • .tlsrxlen R/O Property
          • .tlssetdata Method
          • .toutcounter R/O property
          • .tx2buffrq Method
          • .tx2buffsize R/O Property (32-bit Platforms Only)
          • .tx2len R/O Property
          • .txbuffrq Method
          • .txbuffsize R/O Property
          • .txclear Method
          • .txfree R/O Property
          • .txlen R/O Property
          • .urlsubstitutes
          • .varbuffrq Method
          • .varbuffsize R/O Property (32-bit Platforms Only)
          • .varlen R/O Property
          • on_sock_data_arrival Event
          • on_sock_data_sent Event
          • on_sock_event Event
          • on_sock_inband Event
          • on_sock_overrun Event
          • on_sock_postdata
          • on_sock_tcp_packet_arrival Event
      • Ssi Object
        • Configuring SSI Channel
          • CLK, DO, and DI Lines
          • Baudrate
          • SSI Modes
          • Direction
        • Sending and Receiving Data
        • More on I2C
        • Properties, Methods
          • .Baudrate Property
          • .Channel Property
          • .Clkmap Property
          • .Dimap Property
          • .Direction Property
          • .Domap Property
          • .Enabled Property
          • .Mode Property
          • .Str Method
          • .Value Method
          • .Zmode Property
      • Stor Object
        • .Base Property
        • .Getdata Method (previously .Get)
        • .Setdata Method (previously .Set)
        • .Size R/O Property
      • Sys Object
        • Overview
          • On_sys_init Event
          • Buffer Management
          • System Timer
          • PLL Management
          • Serial Number
          • Miscellaneous
        • Properties, Methods, Events
          • .buffalloc Method
          • .currentpll R/O Property
          • .debugmode Property
          • .debugprint Method
          • .defaultapp Property
          • .freebuffpages R/O Property
          • .getexceptioninfo Method
          • .halt Method
          • .monversion R/O Property
          • .newpll Method
          • .onsystimerperiod Property
          • .reboot Method
          • .reboottoapp Method
          • .resettype R/O Property
          • .runmode R/O Property
          • .serialnum R/O Property
          • .setserialnum Method
          • .sleep Method
          • .timercount R/O Property
          • .timercount32 R/O Property
          • .timercountms Property
          • .timercountmse R/O Property
          • .totalbuffpages R/O Property
          • .version R/O Property
          • on_sys_dhcp_failure Event
          • on_sys_dhcp_ok Event
          • on_sys_init Event
          • on_sys_timer Event
      • Wln Object
        • Overview
          • Quick Reference: WA2000 vs. GA1000
          • Wi-Fi Parlance Primer
          • Wln Tasks
          • Wln State Transitions
          • Bringing Up Wi-Fi Interface
            • Configuring Interface Lines
            • Applying Hardware Reset
            • Selecting Domain (Optional)
            • Selecting Allowed Bands (Optional)
            • Allocating Buffer Memory
            • Setting MAC Address (Optional)
            • Determining Wi-Fi Module Type
            • Booting Up the Hardware
            • Setting IP, Gateway IP, and Netmask
          • Scanning for Wi-Fi Networks
            • Discovering All Wireless Networks
            • Collecting Data About the Specified Network
            • Multiple Access Points With the Same Name
          • Setting Wi-Fi Security
            • Setting WEP Mode and Key
            • Setting WPA Mode and Key
          • Associating With a Network
            • Wln.associate on GA1000
            • Wln.associate on WA2000
          • Creating Own Network
          • Communicating via Wi-Fi Interface
          • Checking the Signal Strength
          • Disassociating From a Network
          • Terminating Own Network
          • Detecting Disassociation or Offline State
          • Disabling Wi-Fi Interface
          • Updating Firmware
        • Properties, Methods, Events
          • .activescan Method
          • .associate Method
          • .associationstate R/O Property
          • .autoconnect Property
          • .autoconnectpassword Property
          • .autoconnectssid Property
          • .autodhcp Property
          • .band Property
          • .boot Method
          • .buffrq Method
          • .buffsize R/O Property
          • .clkmap Property
          • .csmap Property
          • .dhcp Property
          • .dimap Property
          • .disable Method
          • .disassociate Method
          • .domain Property
          • .domap Property
          • .enabled R/O Property
          • .fwversion R/O Property
          • .gatewayip Property
          • .getmoduletype Method
          • .ip Property
          • .mac Property
          • .monversion R/O Property
          • .netmask Property
          • .networkstart Method
          • .networkstop Method
          • .rssi R/O Property
          • .scan Method
          • .scanfilter Property
          • .scanresultbssid R/O Property
          • .scanresultbssmode R/O Property
          • .scanresultchannel R/O Property
          • .scanresultrssi R/O Property
          • .scanresultssid R/O Property
          • .scanresultwpainfo R/O Property
          • .settxpower Method
          • .setupgraderegion Method
          • .setwep Method
          • .setwpa Method
          • .task R/O Property
          • .upgrade Method
          • .waitforupgradecompletion Method
          • .writeflashpage Method
          • on_wln_event Event
          • on_wln_task_complete Event
    • Libraries
      • Common Library Info
        • Library Sets
        • Anatomy of Tibbo Libraries
        • Libraries and Platforms
        • Adding Library Files to Projects
        • About _get_info() API Functions
        • Library Configurators
      • Library Reference
        • AGG (AggreGate) Library
          • AggreGate Configurator
          • The Access Control Demo
          • The Steps
            • Preparing the AggreGate Server
            • Step 1: The Embryo
            • Step 2: Adding Setting A-variables
              • Define Required Settings
              • Define Required A-variables
            • Step 3: Adding Table A-variables
              • Define the User Table
              • Add the Table A-variable
            • Step 4: Adding A-functions
              • Adding A-function
            • Step 5: Firing Instant A-events
              • Adding Instant A-event
            • Step 6: Handling Stored A-events
              • Define the ACE Table
              • Define the ACE Stored Event
            • Step 7: Gluing it All Together
            • Step 8: Adding Bells and Whistles
          • En_agg_event_levels
          • En_agg_status_codes
          • Library Procedures
            • Agg_start()
            • Agg_stop()
            • Agg_get_connection_state()
            • Agg_record_decode()
            • Agg_record_encode()
            • Agg_fire_instant_event()
            • Agg_stored_event_added()
            • Agg_proc_stored_events()
            • Agg_proc_timer()
            • Agg_proc_data()
            • Agg_proc_sock_event()
            • Agg_proc_data_sent()
            • Callback_agg_get_firmware_version()
            • Callback_agg_device_function()
            • Callback_agg_synchronized()
            • Callback_agg_pre_buffrq()
            • Callback_agg_buff_released()
            • Callback_agg_error()
            • Callback_agg_convert_setting()
            • Callback_agg_convert_event_field()
            • Callback_agg_rtc_sg()
        • DHCP Library
          • Step-by-step Usage Instructions
          • Operation Details
          • Code Examples
            • Step 1: Code Example for the Ethernet Interface
            • Step 2: Code Example for the Wi-Fi Interface
            • Step 3: Adding Bells and Whistles
            • Step 4: Adding More Bells and Whistles
          • Library Defines (Options)
          • En_dhcp_status_codes
          • Library Procedures
            • Dhcp_get_info()
            • Dhcp_start()
            • Dhcp_stop()
            • Dhcp_proc_timer()
            • Dhcp_proc_data()
            • Callback_dhcp_ok()
            • Callback_dhcp_failure()
            • Callback_dhcp_pre_clear_ip()
            • Callback_dhcp_pre_buffrq()
            • Callback_dhcp_buff_released()
        • FILENUM (File Numbers) Library
          • Step-by-step Usage Instructions
          • Operation Details
          • A Code Snippet
          • Library Defines (Options)
          • Library Procedures
            • Filenum_get()
            • Filenum_who_uses()
            • Filenum_release()
        • GPRS (PPP) Library
          • Step-by-step Usage Instructions
          • Operation Details
          • Code Example
          • Library Defines (Options)
          • En_gprs_status_codes
          • Library Procedures
            • Gprs_get_info()
            • Gprs_start()
            • Gprs_stop()
            • Gprs_proc_timer()
            • Gprs_proc_sock_data()
            • Gprs_proc_ser_data()
            • Callback_gprs_ok()
            • Callback_gprs_failure()
            • Callback_gprs_pre_buffrq()
        • LUIS Library
        • PPPOE Library
          • Step-by-step Usage Instructions
          • Operation Details
          • Code Example
          • Library Defines (Options)
          • En_pppoe_status_codes
          • Library Procedures
            • Pppoe_get_info()
            • Pppoe_start()
            • Pppoe_stop()
            • Pppoe_proc_timer()
            • Pppoe_proc_data()
            • Callback_pppoe_ok()
            • Callback_pppoe_failure()
            • Callback_pppoe_pre_buffrq()
        • SCAP
          • Step-by-Step Usage Instructions
          • A Code Snippet
          • Library Defines (Options)
        • SOCK (Socket Numbers) Library
          • Step-by-step Usage Instructions
          • Operation Details
          • A Code Snippet
          • Library Defines (Options)
          • Library Procedures
            • Sock_get()
            • Sock_who_uses()
            • Sock_release()
        • STG (Settings) Library
          • Controlling Your Device Through Settings
          • Setting Configurator
            • Library Options
            • Editing Settings
            • Dot-decimal Settings
            • Max Number of Members
            • P1 and P2 Parameters
            • Default Setting Values
          • Step-by-step Usage Instructions
            • Getting Started
            • Verifying and Initializing Settings
            • Writing and Reading Settings
              • Using Stg_sg()
              • Using Stg_get() and Stg_set()
              • Using Setting Numbers
              • Working With Multi-value Settings
              • Understanding Timestamps
              • Using Pre-gets and Post-sets
          • Operation Details
          • Sample Project
            • Step 1: The Embryo
            • Step 2: Adding Setting Initialization
            • Step 3: Adding Comms
            • Step 4: Completing the Project
          • Stg_timestamp Global Variable
          • En_stg_status_codes
          • Library Procedures
            • Stg_start()
            • Stg_check_all()
            • Stg_get_def()
            • Stg_restore_multiple()
            • Stg_restore_member()
            • Stg_get_num_settings()
            • Stg_get_num_members()
            • Stg_find()
            • Stg_stype_get()
            • Stg_get()
            • Stg_set()
            • Stg_sg()
            • Stg_set_ts()
            • Callback_stg_error()
            • Callback_stg_pre_get()
            • Callback_stg_post_set()
            • Callback_stg_vm_read()
            • Callback_stg_vm_write()
        • WLN (Wi-Fi Association) Library
          • Step-by-step Usage Instructions
          • Operation Details
          • Code Examples
            • Step 1: The Simplest Example
            • Step 2: Adding TCP Comms
            • Step 3: Trying WPA
            • Step 4: Roaming Between Access Points
          • Library Defines (Options)
          • En_wln_status_codes
          • Library Procedures
            • Wln_get_info()
            • Wln_start()
            • Wln_stop()
            • Wln_change()
            • Wln_rescan()
            • Wln_wpa_mkey_get()
            • Wln_check_association()
            • Wln_proc_timer()
            • Wln_proc_data()
            • Wln_proc_task_complete()
            • Wln_proc_event()
            • Callback_wln_ok()
            • Callback_wln_failure()
            • Callback_wln_pre_buffrq()
            • Callback_wln_mkey_progress_update()
            • Callback_wln_rescan_result()
        • MQTT Library
          • Step-by-step Usage Instructions
          • Code Example
          • Library Defines (Options)
          • en_qos_choices
          • Library Procedures
            • mqtt_start()
            • mqtt_connect()
            • mqtt_reconnect()
            • mqtt_disconnect()
            • mqtt_publish()
            • mqtt_sub()
            • mqtt_unsub()
            • mqtt_proc_timer()
            • mqtt_proc_data()
            • callback_mqtt_connect_ok()
            • callback_mqtt_connect_lost()
            • callback_mqtt_notif()
            • callback_mqtt_sub_ok()
  • C A R D S
    • Variable Types
    • Initialize the display on DS1101 and DS1102
    • Initialize the display on DS1101 and DS1102 (BASIC example)
    • Initialize the display on DS1101 and DS1102 (C example)
    • Initialize the display on TPS2L
    • Initialize the display on TPS2L (BASIC example)
    • Initialize the display on TPS2L (C example)
  • Legal Information
  • Manual Update History

Callback_agg_buff_released()

Description:

Callback procedure, informs of the release of buffer pages by the library. Procedure body has to be created elsewhere in the project (externally with respect to the library).

Syntax:

sub callback_agg_buff_released()

Returns:

---

See Also:

Adding Bells and Whistles

agg_stop()

Details

The number of free buffer pages can be checked through the sys.freebuffpages R/O property.