pyasic

CGMinerRPCAPI

Bases: BaseMinerRPCAPI

An abstraction of the CGMiner API.

Each method corresponds to an API command in GGMiner.

CGMiner API documentation

This class abstracts use of the CGMiner API, as well as the methods for sending commands to it. The self.send_command() function handles sending a command to the miner asynchronously, and as such is the base for many of the functions in this class, which rely on it to send the command for them.

Source code in pyasic/rpc/cgminer.py

class CGMinerRPCAPI(BaseMinerRPCAPI):
    """An abstraction of the CGMiner API.

    Each method corresponds to an API command in GGMiner.

    [CGMiner API documentation](https://github.com/ckolivas/cgminer/blob/master/API-README)

    This class abstracts use of the CGMiner API, as well as the
    methods for sending commands to it.  The self.send_command()
    function handles sending a command to the miner asynchronously, and
    as such is the base for many of the functions in this class, which
    rely on it to send the command for them.
    """

    async def version(self) -> dict:
        """Get miner version info.
        <details>
            <summary>Expand</summary>

        Returns:
            Miner version information.
        </details>
        """
        return await self.send_command("version")

    async def config(self) -> dict:
        """Get some basic configuration info.
        <details>
            <summary>Expand</summary>

        Returns:
            ## Some miner configuration information:
                * ASC Count <- the number of ASCs
                * PGA Count <- the number of PGAs
                * Pool Count <- the number of Pools
                * Strategy <- the current pool strategy
                * Log Interval <- the interval of logging
                * Device Code <- list of compiled device drivers
                * OS <- the current operating system
                * Failover-Only <- failover-only setting
                * Scan Time <- scan-time setting
                * Queue <- queue setting
                * Expiry <- expiry setting
        </details>
        """
        return await self.send_command("config")

    async def summary(self) -> dict:
        """Get the status summary of the miner.
        <details>
            <summary>Expand</summary>

        Returns:
            The status summary of the miner.
        </details>
        """
        return await self.send_command("summary")

    async def pools(self) -> dict:
        """Get pool information.
        <details>
            <summary>Expand</summary>

        Returns:
            Miner pool information.
        </details>
        """
        return await self.send_command("pools")

    async def devs(self) -> dict:
        """Get data on each PGA/ASC with their details.
        <details>
            <summary>Expand</summary>

        Returns:
            Data on each PGA/ASC with their details.
        </details>
        """
        return await self.send_command("devs")

    async def edevs(self, old: bool = False) -> dict:
        """Get data on each PGA/ASC with their details, ignoring blacklisted and zombie devices.
        <details>
            <summary>Expand</summary>

        Parameters:
            old: Include zombie devices that became zombies less than 'old' seconds ago

        Returns:
            Data on each PGA/ASC with their details.
        </details>
        """
        if old:
            return await self.send_command("edevs", parameters=old)
        else:
            return await self.send_command("edevs")

    async def pga(self, n: int) -> dict:
        """Get data from PGA n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The PGA number to get data from.

        Returns:
            Data on the PGA n.
        </details>
        """
        return await self.send_command("pga", parameters=n)

    async def pgacount(self) -> dict:
        """Get data fon all PGAs.
        <details>
            <summary>Expand</summary>

        Returns:
            Data on the PGAs connected.
        </details>
        """
        return await self.send_command("pgacount")

    async def switchpool(self, n: int) -> dict:
        """Switch pools to pool n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The pool to switch to.

        Returns:
            A confirmation of switching to pool n.
        </details>
        """
        return await self.send_command("switchpool", parameters=n)

    async def enablepool(self, n: int) -> dict:
        """Enable pool n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The pool to enable.

        Returns:
            A confirmation of enabling pool n.
        </details>
        """
        return await self.send_command("enablepool", parameters=n)

    async def addpool(self, url: str, username: str, password: str) -> dict:
        """Add a pool to the miner.
        <details>
            <summary>Expand</summary>

        Parameters:
            url: The URL of the new pool to add.
            username: The users username on the new pool.
            password: The worker password on the new pool.

        Returns:
            A confirmation of adding the pool.
        </details>
        """
        return await self.send_command(
            "addpool", parameters=f"{url},{username},{password}"
        )

    async def poolpriority(self, *n: int) -> dict:
        """Set pool priority.
        <details>
            <summary>Expand</summary>

        Parameters:
            *n: Pools in order of priority.

        Returns:
            A confirmation of setting pool priority.
        </details>
        """
        pools = f"{','.join([str(item) for item in n])}"
        return await self.send_command("poolpriority", parameters=pools)

    async def poolquota(self, n: int, q: int) -> dict:
        """Set pool quota.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: Pool number to set quota on.
            q: Quota to set the pool to.

        Returns:
            A confirmation of setting pool quota.
        </details>
        """
        return await self.send_command("poolquota", parameters=f"{n},{q}")

    async def disablepool(self, n: int) -> dict:
        """Disable a pool.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: Pool to disable.

        Returns:
            A confirmation of diabling the pool.
        </details>
        """
        return await self.send_command("disablepool", parameters=n)

    async def removepool(self, n: int) -> dict:
        """Remove a pool.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: Pool to remove.

        Returns:
            A confirmation of removing the pool.
        </details>
        """
        return await self.send_command("removepool", parameters=n)

    async def save(self, filename: str = None) -> dict:
        """Save the config.
        <details>
            <summary>Expand</summary>

        Parameters:
            filename: Filename to save the config as.

        Returns:
            A confirmation of saving the config.
        </details>
        """
        if filename:
            return await self.send_command("save", parameters=filename)
        else:
            return await self.send_command("save")

    async def quit(self) -> dict:
        """Quit CGMiner.
        <details>
            <summary>Expand</summary>

        Returns:
            A single "BYE" before CGMiner quits.
        </details>
        """
        return await self.send_command("quit")

    async def notify(self) -> dict:
        """Notify the user of past errors.
        <details>
            <summary>Expand</summary>

        Returns:
            The last status and count of each devices problem(s).
        </details>
        """
        return await self.send_command("notify")

    async def privileged(self) -> dict:
        """Check if you have privileged access.
        <details>
            <summary>Expand</summary>

        Returns:
            The STATUS section with an error if you have no privileged access, or success if you have privileged access.
        </details>
        """
        return await self.send_command("privileged")

    async def pgaenable(self, n: int) -> dict:
        """Enable PGA n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The PGA to enable.

        Returns:
            A confirmation of enabling PGA n.
        </details>
        """
        return await self.send_command("pgaenable", parameters=n)

    async def pgadisable(self, n: int) -> dict:
        """Disable PGA n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The PGA to disable.

        Returns:
            A confirmation of disabling PGA n.
        </details>
        """
        return await self.send_command("pgadisable", parameters=n)

    async def pgaidentify(self, n: int) -> dict:
        """Identify PGA n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The PGA to identify.

        Returns:
            A confirmation of identifying PGA n.
        </details>
        """
        return await self.send_command("pgaidentify", parameters=n)

    async def devdetails(self) -> dict:
        """Get data on all devices with their static details.
        <details>
            <summary>Expand</summary>

        Returns:
            Data on all devices with their static details.
        </details>
        """
        return await self.send_command("devdetails")

    async def restart(self) -> dict:
        """Restart CGMiner using the API.
        <details>
            <summary>Expand</summary>

        Returns:
            A reply informing of the restart.
        </details>
        """
        return await self.send_command("restart")

    async def stats(self) -> dict:
        """Get stats of each device/pool with more than 1 getwork.
        <details>
            <summary>Expand</summary>

        Returns:
            Stats of each device/pool with more than 1 getwork.
        </details>
        """
        return await self.send_command("stats")

    async def estats(self, old: bool = False) -> dict:
        """Get stats of each device/pool with more than 1 getwork, ignoring zombie devices.
        <details>
            <summary>Expand</summary>

        Parameters:
            old: Include zombie devices that became zombies less than 'old' seconds ago.

        Returns:
            Stats of each device/pool with more than 1 getwork, ignoring zombie devices.
        </details>
        """
        if old:
            return await self.send_command("estats", parameters=old)
        else:
            return await self.send_command("estats")

    async def check(self, command: str) -> dict:
        """Check if the command command exists in CGMiner.
        <details>
            <summary>Expand</summary>

        Parameters:
            command: The command to check.

        Returns:
            ## Information about a command:
                * Exists (Y/N) <- the command exists in this version
                * Access (Y/N) <- you have access to use the command
        </details>
        """
        return await self.send_command("check", parameters=command)

    async def failover_only(self, failover: bool) -> dict:
        """Set failover-only.
        <details>
            <summary>Expand</summary>

        Parameters:
            failover: What to set failover-only to.

        Returns:
            Confirmation of setting failover-only.
        </details>
        """
        return await self.send_command("failover-only", parameters=failover)

    async def coin(self) -> dict:
        """Get information on the current coin.
        <details>
            <summary>Expand</summary>

        Returns:
            ## Information about the current coin being mined:
                * Hash Method <- the hashing algorithm
                * Current Block Time <- blocktime as a float, 0 means none
                * Current Block Hash <- the hash of the current block, blank means none
                * LP <- whether LP is in use on at least 1 pool
                * Network Difficulty: the current network difficulty
        </details>
        """
        return await self.send_command("coin")

    async def debug(self, setting: str) -> dict:
        """Set a debug setting.
        <details>
            <summary>Expand</summary>

        Parameters:
            setting: Which setting to switch to.
                ## Options are:
                    * Silent
                    * Quiet
                    * Verbose
                    * Debug
                    * RPCProto
                    * PerDevice
                    * WorkTime
                    * Normal

        Returns:
            Data on which debug setting was enabled or disabled.
        </details>
        """
        return await self.send_command("debug", parameters=setting)

    async def setconfig(self, name: str, n: int) -> dict:
        """Set config of name to value n.
        <details>
            <summary>Expand</summary>

        Parameters:
            name: The name of the config setting to set.
                ## Options are:
                    * queue
                    * scantime
                    * expiry
            n: The value to set the 'name' setting to.

        Returns:
            The results of setting config of name to n.
        </details>
        """
        return await self.send_command("setconfig", parameters=f"{name},{n}")

    async def usbstats(self) -> dict:
        """Get stats of all USB devices except ztex.
        <details>
            <summary>Expand</summary>

        Returns:
            The stats of all USB devices except ztex.
        </details>
        """
        return await self.send_command("usbstats")

    async def pgaset(self, n: int, opt: str, val: int = None) -> dict:
        """Set PGA option opt to val on PGA n.
        <details>
            <summary>Expand</summary>

        Options:
        ```
            MMQ -
                opt: clock
                val: 160 - 230 (multiple of 2)
            CMR -
                opt: clock
                val: 100 - 220
        ```

        Parameters:
            n: The PGA to set the options on.
            opt: The option to set. Setting this to 'help' returns a help message.
            val: The value to set the option to.

        Returns:
            Confirmation of setting PGA n with opt[,val].
        </details>
        """
        if val:
            return await self.send_command("pgaset", parameters=f"{n},{opt},{val}")
        else:
            return await self.send_command("pgaset", parameters=f"{n},{opt}")

    async def zero(self, which: str, summary: bool) -> dict:
        """Zero a device.
        <details>
            <summary>Expand</summary>

        Parameters:
            which: Which device to zero. Setting this to 'all' zeros all devices.
                   Setting this to 'bestshare' zeros only the bestshare values for each pool and global.
            summary: Whether or not to show a full summary.


        Returns:
            the STATUS section with info on the zero and optional summary.
        </details>
        """
        return await self.send_command("zero", parameters=f"{which},{summary}")

    async def hotplug(self, n: int) -> dict:
        """Enable hotplug.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The device number to set hotplug on.

        Returns:
            Information on hotplug status.
        </details>
        """
        return await self.send_command("hotplug", parameters=n)

    async def asc(self, n: int) -> dict:
        """Get data for ASC device n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The device to get data for.

        Returns:
            The data for ASC device n.
        </details>
        """
        return await self.send_command("asc", parameters=n)

    async def ascenable(self, n: int) -> dict:
        """Enable ASC device n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The device to enable.

        Returns:
            Confirmation of enabling ASC device n.
        </details>
        """
        return await self.send_command("ascenable", parameters=n)

    async def ascdisable(self, n: int) -> dict:
        """Disable ASC device n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The device to disable.

        Returns:
            Confirmation of disabling ASC device n.
        </details>
        """
        return await self.send_command("ascdisable", parameters=n)

    async def ascidentify(self, n: int) -> dict:
        """Identify ASC device n.
        <details>
            <summary>Expand</summary>

        Parameters:
            n: The device to identify.

        Returns:
            Confirmation of identifying ASC device n.
        </details>
        """
        return await self.send_command("ascidentify", parameters=n)

    async def asccount(self) -> dict:
        """Get data on the number of ASC devices and their info.
        <details>
            <summary>Expand</summary>

        Returns:
            Data on all ASC devices.
        </details>
        """
        return await self.send_command("asccount")

    async def ascset(self, n: int, opt: str, val: int = None) -> dict:
        """Set ASC n option opt to value val.
        <details>
            <summary>Expand</summary>

        Sets an option on the ASC n to a value.  Allowed options are:
        ```
            AVA+BTB -
                opt: freq
                val: 256 - 1024 (chip frequency)
            BTB -
                opt: millivolts
                val: 1000 - 1400 (core voltage)
            MBA -
                opt: reset
                val: 0 - # of chips (reset a chip)

                opt: freq
                val: 0 - # of chips, 100 - 1400 (chip frequency)

                opt: ledcount
                val: 0 - 100 (chip count for LED)

                opt: ledlimit
                val: 0 - 200 (LED off below GH/s)

                opt: spidelay
                val: 0 - 9999 (SPI per I/O delay)

                opt: spireset
                val: i or s, 0 - 9999 (SPI regular reset)

                opt: spisleep
                val: 0 - 9999 (SPI reset sleep in ms)
            BMA -
                opt: volt
                val: 0 - 9

                opt: clock
                val: 0 - 15
        ```

        Parameters:
            n: The ASC to set the options on.
            opt: The option to set. Setting this to 'help' returns a help message.
            val: The value to set the option to.

        Returns:
            Confirmation of setting option opt to value val.
        </details>
        """
        if val:
            return await self.send_command("ascset", parameters=f"{n},{opt},{val}")
        else:
            return await self.send_command("ascset", parameters=f"{n},{opt}")

    async def lcd(self) -> dict:
        """Get a general all-in-one status summary of the miner.
        <details>
            <summary>Expand</summary>

        Returns:
            An all-in-one status summary of the miner.
        </details>
        """
        return await self.send_command("lcd")

    async def lockstats(self) -> dict:
        """Write lockstats to STDERR.
        <details>
            <summary>Expand</summary>

        Returns:
            The result of writing the lock stats to STDERR.
        </details>
        """
        return await self.send_command("lockstats")

addpool(url, username, password) async

Add a pool to the miner.

Expand

Parameters:

Name	Type	Description	Default
url	str	The URL of the new pool to add.	required
username	str	The users username on the new pool.	required
password	str	The worker password on the new pool.	required

Returns:

Type	Description
dict	A confirmation of adding the pool.

Source code in pyasic/rpc/cgminer.py

async def addpool(self, url: str, username: str, password: str) -> dict:
    """Add a pool to the miner.
    <details>
        <summary>Expand</summary>

    Parameters:
        url: The URL of the new pool to add.
        username: The users username on the new pool.
        password: The worker password on the new pool.

    Returns:
        A confirmation of adding the pool.
    </details>
    """
    return await self.send_command(
        "addpool", parameters=f"{url},{username},{password}"
    )

asc(n) async

Get data for ASC device n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The device to get data for.	required

Returns:

Type	Description
dict	The data for ASC device n.

Source code in pyasic/rpc/cgminer.py

async def asc(self, n: int) -> dict:
    """Get data for ASC device n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The device to get data for.

    Returns:
        The data for ASC device n.
    </details>
    """
    return await self.send_command("asc", parameters=n)

asccount() async

Get data on the number of ASC devices and their info.

Expand

Returns:

Type	Description
dict	Data on all ASC devices.

Source code in pyasic/rpc/cgminer.py

async def asccount(self) -> dict:
    """Get data on the number of ASC devices and their info.
    <details>
        <summary>Expand</summary>

    Returns:
        Data on all ASC devices.
    </details>
    """
    return await self.send_command("asccount")

ascdisable(n) async

Disable ASC device n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The device to disable.	required

Returns:

Type	Description
dict	Confirmation of disabling ASC device n.

Source code in pyasic/rpc/cgminer.py

async def ascdisable(self, n: int) -> dict:
    """Disable ASC device n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The device to disable.

    Returns:
        Confirmation of disabling ASC device n.
    </details>
    """
    return await self.send_command("ascdisable", parameters=n)

ascenable(n) async

Enable ASC device n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The device to enable.	required

Returns:

Type	Description
dict	Confirmation of enabling ASC device n.

Source code in pyasic/rpc/cgminer.py

async def ascenable(self, n: int) -> dict:
    """Enable ASC device n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The device to enable.

    Returns:
        Confirmation of enabling ASC device n.
    </details>
    """
    return await self.send_command("ascenable", parameters=n)

ascidentify(n) async

Identify ASC device n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The device to identify.	required

Returns:

Type	Description
dict	Confirmation of identifying ASC device n.

Source code in pyasic/rpc/cgminer.py

async def ascidentify(self, n: int) -> dict:
    """Identify ASC device n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The device to identify.

    Returns:
        Confirmation of identifying ASC device n.
    </details>
    """
    return await self.send_command("ascidentify", parameters=n)

ascset(n, opt, val=None) async

Set ASC n option opt to value val.

Expand

Sets an option on the ASC n to a value. Allowed options are:

    AVA+BTB -
        opt: freq
        val: 256 - 1024 (chip frequency)
    BTB -
        opt: millivolts
        val: 1000 - 1400 (core voltage)
    MBA -
        opt: reset
        val: 0 - # of chips (reset a chip)

        opt: freq
        val: 0 - # of chips, 100 - 1400 (chip frequency)

        opt: ledcount
        val: 0 - 100 (chip count for LED)

        opt: ledlimit
        val: 0 - 200 (LED off below GH/s)

        opt: spidelay
        val: 0 - 9999 (SPI per I/O delay)

        opt: spireset
        val: i or s, 0 - 9999 (SPI regular reset)

        opt: spisleep
        val: 0 - 9999 (SPI reset sleep in ms)
    BMA -
        opt: volt
        val: 0 - 9

        opt: clock
        val: 0 - 15

Parameters:

Name	Type	Description	Default
n	int	The ASC to set the options on.	required
opt	str	The option to set. Setting this to 'help' returns a help message.	required
val	int	The value to set the option to.	None

Returns:

Type	Description
dict	Confirmation of setting option opt to value val.

Source code in pyasic/rpc/cgminer.py

async def ascset(self, n: int, opt: str, val: int = None) -> dict:
    """Set ASC n option opt to value val.
    <details>
        <summary>Expand</summary>

    Sets an option on the ASC n to a value.  Allowed options are:
    ```
        AVA+BTB -
            opt: freq
            val: 256 - 1024 (chip frequency)
        BTB -
            opt: millivolts
            val: 1000 - 1400 (core voltage)
        MBA -
            opt: reset
            val: 0 - # of chips (reset a chip)

            opt: freq
            val: 0 - # of chips, 100 - 1400 (chip frequency)

            opt: ledcount
            val: 0 - 100 (chip count for LED)

            opt: ledlimit
            val: 0 - 200 (LED off below GH/s)

            opt: spidelay
            val: 0 - 9999 (SPI per I/O delay)

            opt: spireset
            val: i or s, 0 - 9999 (SPI regular reset)

            opt: spisleep
            val: 0 - 9999 (SPI reset sleep in ms)
        BMA -
            opt: volt
            val: 0 - 9

            opt: clock
            val: 0 - 15
    ```

    Parameters:
        n: The ASC to set the options on.
        opt: The option to set. Setting this to 'help' returns a help message.
        val: The value to set the option to.

    Returns:
        Confirmation of setting option opt to value val.
    </details>
    """
    if val:
        return await self.send_command("ascset", parameters=f"{n},{opt},{val}")
    else:
        return await self.send_command("ascset", parameters=f"{n},{opt}")

check(command) async

Check if the command command exists in CGMiner.

Expand

Parameters:

Name	Type	Description	Default
command	str	The command to check.	required

Returns:

Type	Description
dict	Information about a command: Exists (Y/N) <- the command exists in this version Access (Y/N) <- you have access to use the command

Source code in pyasic/rpc/cgminer.py

async def check(self, command: str) -> dict:
    """Check if the command command exists in CGMiner.
    <details>
        <summary>Expand</summary>

    Parameters:
        command: The command to check.

    Returns:
        ## Information about a command:
            * Exists (Y/N) <- the command exists in this version
            * Access (Y/N) <- you have access to use the command
    </details>
    """
    return await self.send_command("check", parameters=command)

coin() async

Get information on the current coin.

Expand

Returns:

Type	Description
dict	Information about the current coin being mined: Hash Method <- the hashing algorithm Current Block Time <- blocktime as a float, 0 means none Current Block Hash <- the hash of the current block, blank means none LP <- whether LP is in use on at least 1 pool Network Difficulty: the current network difficulty

Source code in pyasic/rpc/cgminer.py

async def coin(self) -> dict:
    """Get information on the current coin.
    <details>
        <summary>Expand</summary>

    Returns:
        ## Information about the current coin being mined:
            * Hash Method <- the hashing algorithm
            * Current Block Time <- blocktime as a float, 0 means none
            * Current Block Hash <- the hash of the current block, blank means none
            * LP <- whether LP is in use on at least 1 pool
            * Network Difficulty: the current network difficulty
    </details>
    """
    return await self.send_command("coin")

config() async

Get some basic configuration info.

Expand

Returns:

Type

Description

dict

Some miner configuration information: ASC Count <- the number of ASCs PGA Count <- the number of PGAs Pool Count <- the number of Pools Strategy <- the current pool strategy Log Interval <- the interval of logging Device Code <- list of compiled device drivers OS <- the current operating system Failover-Only <- failover-only setting Scan Time <- scan-time setting Queue <- queue setting Expiry <- expiry setting

Source code in pyasic/rpc/cgminer.py

async def config(self) -> dict:
    """Get some basic configuration info.
    <details>
        <summary>Expand</summary>

    Returns:
        ## Some miner configuration information:
            * ASC Count <- the number of ASCs
            * PGA Count <- the number of PGAs
            * Pool Count <- the number of Pools
            * Strategy <- the current pool strategy
            * Log Interval <- the interval of logging
            * Device Code <- list of compiled device drivers
            * OS <- the current operating system
            * Failover-Only <- failover-only setting
            * Scan Time <- scan-time setting
            * Queue <- queue setting
            * Expiry <- expiry setting
    </details>
    """
    return await self.send_command("config")

debug(setting) async

Set a debug setting.

Expand

Parameters:

Name	Type	Description	Default
setting	str	Which setting to switch to. Options are: * Silent * Quiet * Verbose * Debug * RPCProto * PerDevice * WorkTime * Normal	required

Returns:

Type	Description
dict	Data on which debug setting was enabled or disabled.

Source code in pyasic/rpc/cgminer.py

async def debug(self, setting: str) -> dict:
    """Set a debug setting.
    <details>
        <summary>Expand</summary>

    Parameters:
        setting: Which setting to switch to.
            ## Options are:
                * Silent
                * Quiet
                * Verbose
                * Debug
                * RPCProto
                * PerDevice
                * WorkTime
                * Normal

    Returns:
        Data on which debug setting was enabled or disabled.
    </details>
    """
    return await self.send_command("debug", parameters=setting)

devdetails() async

Get data on all devices with their static details.

Expand

Returns:

Type	Description
dict	Data on all devices with their static details.

Source code in pyasic/rpc/cgminer.py

async def devdetails(self) -> dict:
    """Get data on all devices with their static details.
    <details>
        <summary>Expand</summary>

    Returns:
        Data on all devices with their static details.
    </details>
    """
    return await self.send_command("devdetails")

devs() async

Get data on each PGA/ASC with their details.

Expand

Returns:

Type	Description
dict	Data on each PGA/ASC with their details.

Source code in pyasic/rpc/cgminer.py

async def devs(self) -> dict:
    """Get data on each PGA/ASC with their details.
    <details>
        <summary>Expand</summary>

    Returns:
        Data on each PGA/ASC with their details.
    </details>
    """
    return await self.send_command("devs")

disablepool(n) async

Disable a pool.

Expand

Parameters:

Name	Type	Description	Default
n	int	Pool to disable.	required

Returns:

Type	Description
dict	A confirmation of diabling the pool.

Source code in pyasic/rpc/cgminer.py

async def disablepool(self, n: int) -> dict:
    """Disable a pool.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: Pool to disable.

    Returns:
        A confirmation of diabling the pool.
    </details>
    """
    return await self.send_command("disablepool", parameters=n)

edevs(old=False) async

Get data on each PGA/ASC with their details, ignoring blacklisted and zombie devices.

Expand

Parameters:

Name	Type	Description	Default
old	bool	Include zombie devices that became zombies less than 'old' seconds ago	False

Returns:

Type	Description
dict	Data on each PGA/ASC with their details.

Source code in pyasic/rpc/cgminer.py

async def edevs(self, old: bool = False) -> dict:
    """Get data on each PGA/ASC with their details, ignoring blacklisted and zombie devices.
    <details>
        <summary>Expand</summary>

    Parameters:
        old: Include zombie devices that became zombies less than 'old' seconds ago

    Returns:
        Data on each PGA/ASC with their details.
    </details>
    """
    if old:
        return await self.send_command("edevs", parameters=old)
    else:
        return await self.send_command("edevs")

enablepool(n) async

Enable pool n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The pool to enable.	required

Returns:

Type	Description
dict	A confirmation of enabling pool n.

Source code in pyasic/rpc/cgminer.py

async def enablepool(self, n: int) -> dict:
    """Enable pool n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The pool to enable.

    Returns:
        A confirmation of enabling pool n.
    </details>
    """
    return await self.send_command("enablepool", parameters=n)

estats(old=False) async

Get stats of each device/pool with more than 1 getwork, ignoring zombie devices.

Expand

Parameters:

Name	Type	Description	Default
old	bool	Include zombie devices that became zombies less than 'old' seconds ago.	False

Returns:

Type	Description
dict	Stats of each device/pool with more than 1 getwork, ignoring zombie devices.

Source code in pyasic/rpc/cgminer.py

async def estats(self, old: bool = False) -> dict:
    """Get stats of each device/pool with more than 1 getwork, ignoring zombie devices.
    <details>
        <summary>Expand</summary>

    Parameters:
        old: Include zombie devices that became zombies less than 'old' seconds ago.

    Returns:
        Stats of each device/pool with more than 1 getwork, ignoring zombie devices.
    </details>
    """
    if old:
        return await self.send_command("estats", parameters=old)
    else:
        return await self.send_command("estats")

failover_only(failover) async

Set failover-only.

Expand

Parameters:

Name	Type	Description	Default
failover	bool	What to set failover-only to.	required

Returns:

Type	Description
dict	Confirmation of setting failover-only.

Source code in pyasic/rpc/cgminer.py

async def failover_only(self, failover: bool) -> dict:
    """Set failover-only.
    <details>
        <summary>Expand</summary>

    Parameters:
        failover: What to set failover-only to.

    Returns:
        Confirmation of setting failover-only.
    </details>
    """
    return await self.send_command("failover-only", parameters=failover)

hotplug(n) async

Enable hotplug.

Expand

Parameters:

Name	Type	Description	Default
n	int	The device number to set hotplug on.	required

Returns:

Type	Description
dict	Information on hotplug status.

Source code in pyasic/rpc/cgminer.py

async def hotplug(self, n: int) -> dict:
    """Enable hotplug.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The device number to set hotplug on.

    Returns:
        Information on hotplug status.
    </details>
    """
    return await self.send_command("hotplug", parameters=n)

lcd() async

Get a general all-in-one status summary of the miner.

Expand

Returns:

Type	Description
dict	An all-in-one status summary of the miner.

Source code in pyasic/rpc/cgminer.py

async def lcd(self) -> dict:
    """Get a general all-in-one status summary of the miner.
    <details>
        <summary>Expand</summary>

    Returns:
        An all-in-one status summary of the miner.
    </details>
    """
    return await self.send_command("lcd")

lockstats() async

Write lockstats to STDERR.

Expand

Returns:

Type	Description
dict	The result of writing the lock stats to STDERR.

Source code in pyasic/rpc/cgminer.py

async def lockstats(self) -> dict:
    """Write lockstats to STDERR.
    <details>
        <summary>Expand</summary>

    Returns:
        The result of writing the lock stats to STDERR.
    </details>
    """
    return await self.send_command("lockstats")

notify() async

Notify the user of past errors.

Expand

Returns:

Type	Description
dict	The last status and count of each devices problem(s).

Source code in pyasic/rpc/cgminer.py

async def notify(self) -> dict:
    """Notify the user of past errors.
    <details>
        <summary>Expand</summary>

    Returns:
        The last status and count of each devices problem(s).
    </details>
    """
    return await self.send_command("notify")

pga(n) async

Get data from PGA n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The PGA number to get data from.	required

Returns:

Type	Description
dict	Data on the PGA n.

Source code in pyasic/rpc/cgminer.py

async def pga(self, n: int) -> dict:
    """Get data from PGA n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The PGA number to get data from.

    Returns:
        Data on the PGA n.
    </details>
    """
    return await self.send_command("pga", parameters=n)

pgacount() async

Get data fon all PGAs.

Expand

Returns:

Type	Description
dict	Data on the PGAs connected.

Source code in pyasic/rpc/cgminer.py

async def pgacount(self) -> dict:
    """Get data fon all PGAs.
    <details>
        <summary>Expand</summary>

    Returns:
        Data on the PGAs connected.
    </details>
    """
    return await self.send_command("pgacount")

pgadisable(n) async

Disable PGA n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The PGA to disable.	required

Returns:

Type	Description
dict	A confirmation of disabling PGA n.

Source code in pyasic/rpc/cgminer.py

async def pgadisable(self, n: int) -> dict:
    """Disable PGA n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The PGA to disable.

    Returns:
        A confirmation of disabling PGA n.
    </details>
    """
    return await self.send_command("pgadisable", parameters=n)

pgaenable(n) async

Enable PGA n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The PGA to enable.	required

Returns:

Type	Description
dict	A confirmation of enabling PGA n.

Source code in pyasic/rpc/cgminer.py

async def pgaenable(self, n: int) -> dict:
    """Enable PGA n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The PGA to enable.

    Returns:
        A confirmation of enabling PGA n.
    </details>
    """
    return await self.send_command("pgaenable", parameters=n)

pgaidentify(n) async

Identify PGA n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The PGA to identify.	required

Returns:

Type	Description
dict	A confirmation of identifying PGA n.

Source code in pyasic/rpc/cgminer.py

async def pgaidentify(self, n: int) -> dict:
    """Identify PGA n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The PGA to identify.

    Returns:
        A confirmation of identifying PGA n.
    </details>
    """
    return await self.send_command("pgaidentify", parameters=n)

pgaset(n, opt, val=None) async

Set PGA option opt to val on PGA n.

Expand

Options:

    MMQ -
        opt: clock
        val: 160 - 230 (multiple of 2)
    CMR -
        opt: clock
        val: 100 - 220

Parameters:

Name	Type	Description	Default
n	int	The PGA to set the options on.	required
opt	str	The option to set. Setting this to 'help' returns a help message.	required
val	int	The value to set the option to.	None

Returns:

Type	Description
dict	Confirmation of setting PGA n with opt[,val].

Source code in pyasic/rpc/cgminer.py

async def pgaset(self, n: int, opt: str, val: int = None) -> dict:
    """Set PGA option opt to val on PGA n.
    <details>
        <summary>Expand</summary>

    Options:
    ```
        MMQ -
            opt: clock
            val: 160 - 230 (multiple of 2)
        CMR -
            opt: clock
            val: 100 - 220
    ```

    Parameters:
        n: The PGA to set the options on.
        opt: The option to set. Setting this to 'help' returns a help message.
        val: The value to set the option to.

    Returns:
        Confirmation of setting PGA n with opt[,val].
    </details>
    """
    if val:
        return await self.send_command("pgaset", parameters=f"{n},{opt},{val}")
    else:
        return await self.send_command("pgaset", parameters=f"{n},{opt}")

poolpriority(*n) async

Set pool priority.

Expand

Parameters:

Name	Type	Description	Default
*n	int	Pools in order of priority.	()

Returns:

Type	Description
dict	A confirmation of setting pool priority.

Source code in pyasic/rpc/cgminer.py

async def poolpriority(self, *n: int) -> dict:
    """Set pool priority.
    <details>
        <summary>Expand</summary>

    Parameters:
        *n: Pools in order of priority.

    Returns:
        A confirmation of setting pool priority.
    </details>
    """
    pools = f"{','.join([str(item) for item in n])}"
    return await self.send_command("poolpriority", parameters=pools)

poolquota(n, q) async

Set pool quota.

Expand

Parameters:

Name	Type	Description	Default
n	int	Pool number to set quota on.	required
q	int	Quota to set the pool to.	required

Returns:

Type	Description
dict	A confirmation of setting pool quota.

Source code in pyasic/rpc/cgminer.py

async def poolquota(self, n: int, q: int) -> dict:
    """Set pool quota.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: Pool number to set quota on.
        q: Quota to set the pool to.

    Returns:
        A confirmation of setting pool quota.
    </details>
    """
    return await self.send_command("poolquota", parameters=f"{n},{q}")

pools() async

Get pool information.

Expand

Returns:

Type	Description
dict	Miner pool information.

Source code in pyasic/rpc/cgminer.py

async def pools(self) -> dict:
    """Get pool information.
    <details>
        <summary>Expand</summary>

    Returns:
        Miner pool information.
    </details>
    """
    return await self.send_command("pools")

privileged() async

Check if you have privileged access.

Expand

Returns:

Type	Description
dict	The STATUS section with an error if you have no privileged access, or success if you have privileged access.

Source code in pyasic/rpc/cgminer.py

async def privileged(self) -> dict:
    """Check if you have privileged access.
    <details>
        <summary>Expand</summary>

    Returns:
        The STATUS section with an error if you have no privileged access, or success if you have privileged access.
    </details>
    """
    return await self.send_command("privileged")

quit() async

Quit CGMiner.

Expand

Returns:

Type	Description
dict	A single "BYE" before CGMiner quits.

Source code in pyasic/rpc/cgminer.py

async def quit(self) -> dict:
    """Quit CGMiner.
    <details>
        <summary>Expand</summary>

    Returns:
        A single "BYE" before CGMiner quits.
    </details>
    """
    return await self.send_command("quit")

removepool(n) async

Remove a pool.

Expand

Parameters:

Name	Type	Description	Default
n	int	Pool to remove.	required

Returns:

Type	Description
dict	A confirmation of removing the pool.

Source code in pyasic/rpc/cgminer.py

async def removepool(self, n: int) -> dict:
    """Remove a pool.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: Pool to remove.

    Returns:
        A confirmation of removing the pool.
    </details>
    """
    return await self.send_command("removepool", parameters=n)

restart() async

Restart CGMiner using the API.

Expand

Returns:

Type	Description
dict	A reply informing of the restart.

Source code in pyasic/rpc/cgminer.py

async def restart(self) -> dict:
    """Restart CGMiner using the API.
    <details>
        <summary>Expand</summary>

    Returns:
        A reply informing of the restart.
    </details>
    """
    return await self.send_command("restart")

save(filename=None) async

Save the config.

Expand

Parameters:

Name	Type	Description	Default
filename	str	Filename to save the config as.	None

Returns:

Type	Description
dict	A confirmation of saving the config.

Source code in pyasic/rpc/cgminer.py

async def save(self, filename: str = None) -> dict:
    """Save the config.
    <details>
        <summary>Expand</summary>

    Parameters:
        filename: Filename to save the config as.

    Returns:
        A confirmation of saving the config.
    </details>
    """
    if filename:
        return await self.send_command("save", parameters=filename)
    else:
        return await self.send_command("save")

setconfig(name, n) async

Set config of name to value n.

Expand

Parameters:

Name	Type	Description	Default
name	str	The name of the config setting to set. Options are: * queue * scantime * expiry	required
n	int	The value to set the 'name' setting to.	required

Returns:

Type	Description
dict	The results of setting config of name to n.

Source code in pyasic/rpc/cgminer.py

async def setconfig(self, name: str, n: int) -> dict:
    """Set config of name to value n.
    <details>
        <summary>Expand</summary>

    Parameters:
        name: The name of the config setting to set.
            ## Options are:
                * queue
                * scantime
                * expiry
        n: The value to set the 'name' setting to.

    Returns:
        The results of setting config of name to n.
    </details>
    """
    return await self.send_command("setconfig", parameters=f"{name},{n}")

stats() async

Get stats of each device/pool with more than 1 getwork.

Expand

Returns:

Type	Description
dict	Stats of each device/pool with more than 1 getwork.

Source code in pyasic/rpc/cgminer.py

async def stats(self) -> dict:
    """Get stats of each device/pool with more than 1 getwork.
    <details>
        <summary>Expand</summary>

    Returns:
        Stats of each device/pool with more than 1 getwork.
    </details>
    """
    return await self.send_command("stats")

summary() async

Get the status summary of the miner.

Expand

Returns:

Type	Description
dict	The status summary of the miner.

Source code in pyasic/rpc/cgminer.py

async def summary(self) -> dict:
    """Get the status summary of the miner.
    <details>
        <summary>Expand</summary>

    Returns:
        The status summary of the miner.
    </details>
    """
    return await self.send_command("summary")

switchpool(n) async

Switch pools to pool n.

Expand

Parameters:

Name	Type	Description	Default
n	int	The pool to switch to.	required

Returns:

Type	Description
dict	A confirmation of switching to pool n.

Source code in pyasic/rpc/cgminer.py

async def switchpool(self, n: int) -> dict:
    """Switch pools to pool n.
    <details>
        <summary>Expand</summary>

    Parameters:
        n: The pool to switch to.

    Returns:
        A confirmation of switching to pool n.
    </details>
    """
    return await self.send_command("switchpool", parameters=n)

usbstats() async

Get stats of all USB devices except ztex.

Expand

Returns:

Type	Description
dict	The stats of all USB devices except ztex.

Source code in pyasic/rpc/cgminer.py

async def usbstats(self) -> dict:
    """Get stats of all USB devices except ztex.
    <details>
        <summary>Expand</summary>

    Returns:
        The stats of all USB devices except ztex.
    </details>
    """
    return await self.send_command("usbstats")

version() async

Get miner version info.

Expand

Returns:

Type	Description
dict	Miner version information.

Source code in pyasic/rpc/cgminer.py

async def version(self) -> dict:
    """Get miner version info.
    <details>
        <summary>Expand</summary>

    Returns:
        Miner version information.
    </details>
    """
    return await self.send_command("version")

zero(which, summary) async

Zero a device.

Expand

Parameters:

Name	Type	Description	Default
which	str	Which device to zero. Setting this to 'all' zeros all devices. Setting this to 'bestshare' zeros only the bestshare values for each pool and global.	required
summary	bool	Whether or not to show a full summary.	required

Returns:

Type	Description
dict	the STATUS section with info on the zero and optional summary.

Source code in pyasic/rpc/cgminer.py

async def zero(self, which: str, summary: bool) -> dict:
    """Zero a device.
    <details>
        <summary>Expand</summary>

    Parameters:
        which: Which device to zero. Setting this to 'all' zeros all devices.
               Setting this to 'bestshare' zeros only the bestshare values for each pool and global.
        summary: Whether or not to show a full summary.


    Returns:
        the STATUS section with info on the zero and optional summary.
    </details>
    """
    return await self.send_command("zero", parameters=f"{which},{summary}")