GCBASIC documentation
String Manipulation

Syntax:

    stringvar = SingleToString(Single_variable)     'supports Single.

Command Availability:

Available on all microcontrollers.

Explanation:

The SingleToString function converts a number into a string. number can be any Single variable. For Byte numbers use ByteToString(), for Word numbers use WordToString(), for Integer numbers use IntegerToString(), and for Long numbers use LongToString().

The string variable stringvar contains the ASCII representation of the input number. The string length is variable, depending on the input value.

This function is especially useful if a number needs to be added to the end of a string, or if a custom data-sending routine only supports the output of string variables.

This function does not support conversion of hexadecimal number strings.

Operational Return Codes

The function returns either the number string or the message "Error ". The reasons for an "Error " result are:

A public variable is available after using this function: SysByte_STS_Err, which returns the following:

    `SysByte_STS_Err` where 1 or 9 equates to no error.

    1 equates to a properly formatted number string.

    8 equates to a properly formatted integer number string.

Bitwise Return Details

    SysByte_STS_Err.0 :  1 = good, or, 0 = bad
    SysByte_STS_Err.1 :  1 = too many decimal-place characters, or, 0 = ok
    SysByte_STS_Err.2 :  1 = too many integer-place characters (out of range), or, 0 = ok
    SysByte_STS_Err.3 :  1 = no decimal point, info only
    SysByte_STS_Err.4 :  1 = non-numeric characters found

Note: When calling SingleToString(), do not leave a space between the function name and the opening parenthesis — doing so produces a compiler error that is not obvious to diagnose.

    ' use this -- no space between SingleToString and the opening parenthesis
    SingleToString(number_variable)

    ' do not use this -- note the space before the parenthesis
    SingleToString (number_variable)

Example 1:

    'Set chip model
    #chip 16F1936

    'Set up hardware serial connection
    #define USART_BAUD_RATE 9600
    #define USART_TX_BLOCKING

    Dim SensorReading as Single

    'Take an A/D reading
    SensorReading = ReadAD(AN0)

    'Create a string variable
    Dim OutVar As String

    'Fill string with sensor reading
    OutVar = SingleToString(SensorReading)          ' <<< the SingleToString instruction

    'Send
    HSerPrint OutVar
    HSerPrintCRLF

    Do
    Loop

    End

Key line: OutVar = SingleToString(SensorReading) — converts the floating-point ADC reading into a decimal string, ready to be transmitted over the serial connection with HSerPrint.

Example 2:

    '''************************************************************************
    '''  PIC: 16F18855
    '''  Compiler: GCB
    '''  IDE: GCode
    '''  Board: Xpress Evaluation Board
    '''  Date: June 2021

    ' ----- Configuration
      'Chip Settings.
      #chip 16f18855,32
      #Config CLRE_ON
      #option Explicit

    ; ----- Define Hardware settings

      'Set the PPS of the RS232 ports.
      UNLOCKPPS
        RC0PPS = 0x0010     'RC0->EUSART:TX;
        RXPPS  = 0x0011     'RC1->EUSART:RX;
      LOCKPPS

    ; ----- Constants
      #define USART_BAUD_RATE 19200
      #define USART_TX_BLOCKING

    ; ----- Variables
    dim Singlevar as Single

    ; ----- Main body of program commences here.
    Singlevar = -10

    do
       wait 100 ms

       HSerPrint SingleToString( Singlevar )          ' <<< the SingleToString instruction
       HSerPrintCRLF
       wait 1 s
    loop

    end

Key line: HSerPrint SingleToString( Singlevar ) — converts the Single value -10 to a string and prints it directly, without needing an intermediate string variable.

See Also: