--- title: "GET /feed/minions" method: GET path: "/feed/minions" tags: ["Feeds"] --- # GET /feed/minions `GET /feed/minions` Minions feed. when minion status changed minion created etc. ## Response `200` Ok - MinionFeed — Minion feed object. - `event` 'created' | 'update' | 'removed', required — Feed update type enum. - `minion` Minion, required — Represents a minion in system. Minion is a logic device in the system, meaning that a device is a physical device and minion is a logic device that uses a physical device to switch home kit status. For example, an IR transmitter can be one physical device for a few minions, one to central AC control and second for secondary AC control so in it will be two totally different minions that use one physical device. - `minionId` string — Minion unique id. - `name` string, required — The display name for a minion. - `device` MinionDevice, required — Represents a physical device kind with network info. - `pysicalDevice` LocalNetworkDevice, required — Represents any physical device in a local network. - `name` string — Display name. - `mac` string, required — The MAC address of the device, the value is unique to each device. - `vendor` string — Info about device manufacturer. - `ip` string — The device IP address, if exist it should be unique in network. - `deviceStatus` DeviceStatus - `battery` number, double — The battery power, if relevant, in %. - `charging` boolean — Is the device in charging mode - `brand` string, required — The brand of device. - `model` string, required — The specific model of the device. - `token` string — Some devices require a token for communication API. - `deviceId` string — Some devices require id for communication API. - `isProperlyCommunicated` boolean — Is communication with device status ok. - `minionStatus` MinionStatus, required — Minion status, the available values depend on the minion type. - `toggle` Toggle — A toggle value, the toggle is on way communicated device, For example wall light switches with 433 RF that can turn on or off but there is no way to know the real light status if someone changes the light status using physical switch. - `status` 'on' | 'off', required — Switches option - `switch` Switch — A switch status. Used for simple devices that can be turned on or off. *and minion status is readable* The properties same as a toggle, and the difference is logic only (if that status is readable or not). - `status` 'on' | 'off', required — Switches option - `roller` Roller — A roller switch status. A roller is a switch for curtains or blinds (or for any other needs) that can drag up/down or stop. - `status` 'on' | 'off', required — Switches option - `direction` 'up' | 'down', required — Roller direction - `cleaner` Cleaner — A Cleaner (robot) status. Cleaner is a smart robot for cleaning home. - `status` 'on' | 'off', required — Switches option - `mode` 'dock' | 'clean', required — Cleaner mode - `fanSpeed` 'low' | 'med' | 'high' | 'auto', required — Valid fan strength. - `airConditioning` AirConditioning — An AC status. - `status` 'on' | 'off', required — Switches option - `temperature` integer, required — Valid AC temperature. (minimum 16° maximum 30°). - `mode` 'hot' | 'cold' | 'dry' | 'auto', required — Valid AC mode. - `fanStrength` 'low' | 'med' | 'high' | 'auto', required — Valid fan strength. - `light` Light — A simple light status. Used to devices that can chang it's brightness. - `status` 'on' | 'off', required — Switches option - `brightness` integer, required — Minimum 1% maximum 100% of light brightness. - `temperatureLight` TemperatureLight — A light simple light status. Used to devices that can chang also light temperature (warm or cold light). - `status` 'on' | 'off', required — Switches option - `brightness` integer, required — Minimum 1% maximum 100% of light brightness. - `temperature` integer, required — Spectrum is 1% to warm light and 100% to cold light. - `colorLight` ColorLight — A light simple light status. Used to devices that can change also light color (RGB). - `status` 'on' | 'off', required — Switches option - `brightness` integer, required — Minimum 1% maximum 100% of light brightness. - `temperature` integer, required — Spectrum is 1% to warm light and 100% to cold light. - `red` integer, required — Minimum 0 maximum 255 from red color. Valid color value. (8 bits number, minimum 0 maximum 255). - `green` integer, required — Minimum 0 maximum 255 from green color. Valid color value. (8 bits number, minimum 0 maximum 255). - `blue` integer, required — Minimum 0 maximum 255 from blue color. Valid color value. (8 bits number, minimum 0 maximum 255). - `temperatureSensor` TemperatureSensor - `status` 'on' | 'off', required — Switches option - `temperature` number, double, required — Temperature in celsius (X°) - `minionType` 'toggle' | 'switch' | 'temperatureSensor' | 'roller' | 'cleaner' | 'airConditioning' | 'light' | 'temperatureLight' | 'colorLight', required — Supported minions types. - `minionAutoTurnOffMS` number, double — Auto turns off duration, *if* set member value then the minion will turn off in X ms after turning it on, Used for example in boiler minion etc. - `calibration` MinionCalibrate — Used to change the minion calibration property value. - `calibrationCycleMinutes` integer, required — Minutes to calibrate status, set 0 to turn off calibration - `calibrationMode` 'LOCK_ON' | 'LOCK_OFF' | 'SHABBAT' | 'AUTO' | 'LOCK_DASHBOARD', required - `room` string — Represents the room where the minion is located at. - `statusChangedTime` number, double — Last status change timestamp in UTC MS - `restrictions` RestrictionItem[] — The restriction of access on this minion - `userEmail` string, required — The use to restrict - `restrictionType` 'BLOCK' | 'READ' | 'WRITE', required — Type of resection of access - `oldMinion` Minion, required — Represents a minion in system. Minion is a logic device in the system, meaning that a device is a physical device and minion is a logic device that uses a physical device to switch home kit status. For example, an IR transmitter can be one physical device for a few minions, one to central AC control and second for secondary AC control so in it will be two totally different minions that use one physical device. - `minionId` string — Minion unique id. - `name` string, required — The display name for a minion. - `device` MinionDevice, required — Represents a physical device kind with network info. - `pysicalDevice` LocalNetworkDevice, required — Represents any physical device in a local network. - `name` string — Display name. - `mac` string, required — The MAC address of the device, the value is unique to each device. - `vendor` string — Info about device manufacturer. - `ip` string — The device IP address, if exist it should be unique in network. - `deviceStatus` DeviceStatus - `battery` number, double — The battery power, if relevant, in %. - `charging` boolean — Is the device in charging mode - `brand` string, required — The brand of device. - `model` string, required — The specific model of the device. - `token` string — Some devices require a token for communication API. - `deviceId` string — Some devices require id for communication API. - `isProperlyCommunicated` boolean — Is communication with device status ok. - `minionStatus` MinionStatus, required — Minion status, the available values depend on the minion type. - `toggle` Toggle — A toggle value, the toggle is on way communicated device, For example wall light switches with 433 RF that can turn on or off but there is no way to know the real light status if someone changes the light status using physical switch. - `status` 'on' | 'off', required — Switches option - `switch` Switch — A switch status. Used for simple devices that can be turned on or off. *and minion status is readable* The properties same as a toggle, and the difference is logic only (if that status is readable or not). - `status` 'on' | 'off', required — Switches option - `roller` Roller — A roller switch status. A roller is a switch for curtains or blinds (or for any other needs) that can drag up/down or stop. - `status` 'on' | 'off', required — Switches option - `direction` 'up' | 'down', required — Roller direction - `cleaner` Cleaner — A Cleaner (robot) status. Cleaner is a smart robot for cleaning home. - `status` 'on' | 'off', required — Switches option - `mode` 'dock' | 'clean', required — Cleaner mode - `fanSpeed` 'low' | 'med' | 'high' | 'auto', required — Valid fan strength. - `airConditioning` AirConditioning — An AC status. - `status` 'on' | 'off', required — Switches option - `temperature` integer, required — Valid AC temperature. (minimum 16° maximum 30°). - `mode` 'hot' | 'cold' | 'dry' | 'auto', required — Valid AC mode. - `fanStrength` 'low' | 'med' | 'high' | 'auto', required — Valid fan strength. - `light` Light — A simple light status. Used to devices that can chang it's brightness. - `status` 'on' | 'off', required — Switches option - `brightness` integer, required — Minimum 1% maximum 100% of light brightness. - `temperatureLight` TemperatureLight — A light simple light status. Used to devices that can chang also light temperature (warm or cold light). - `status` 'on' | 'off', required — Switches option - `brightness` integer, required — Minimum 1% maximum 100% of light brightness. - `temperature` integer, required — Spectrum is 1% to warm light and 100% to cold light. - `colorLight` ColorLight — A light simple light status. Used to devices that can change also light color (RGB). - `status` 'on' | 'off', required — Switches option - `brightness` integer, required — Minimum 1% maximum 100% of light brightness. - `temperature` integer, required — Spectrum is 1% to warm light and 100% to cold light. - `red` integer, required — Minimum 0 maximum 255 from red color. Valid color value. (8 bits number, minimum 0 maximum 255). - `green` integer, required — Minimum 0 maximum 255 from green color. Valid color value. (8 bits number, minimum 0 maximum 255). - `blue` integer, required — Minimum 0 maximum 255 from blue color. Valid color value. (8 bits number, minimum 0 maximum 255). - `temperatureSensor` TemperatureSensor - `status` 'on' | 'off', required — Switches option - `temperature` number, double, required — Temperature in celsius (X°) - `minionType` 'toggle' | 'switch' | 'temperatureSensor' | 'roller' | 'cleaner' | 'airConditioning' | 'light' | 'temperatureLight' | 'colorLight', required — Supported minions types. - `minionAutoTurnOffMS` number, double — Auto turns off duration, *if* set member value then the minion will turn off in X ms after turning it on, Used for example in boiler minion etc. - `calibration` MinionCalibrate — Used to change the minion calibration property value. - `calibrationCycleMinutes` integer, required — Minutes to calibrate status, set 0 to turn off calibration - `calibrationMode` 'LOCK_ON' | 'LOCK_OFF' | 'SHABBAT' | 'AUTO' | 'LOCK_DASHBOARD', required - `room` string — Represents the room where the minion is located at. - `statusChangedTime` number, double — Last status change timestamp in UTC MS - `restrictions` RestrictionItem[] — The restriction of access on this minion - `userEmail` string, required — The use to restrict - `restrictionType` 'BLOCK' | 'READ' | 'WRITE', required — Type of resection of access - `trigger` 'user' | 'device' | 'timeout' | 'timing' | 'action' | 'lock' | 'sync' | 'rotation' | 'external' — The minion status change triggers - `user` User — Represents a user in the system. - `displayName` string — Name - `email` string, required — User email - `password` string — User password. - `ignoreTfa` boolean, required — Ignore 2-step verification on login or not. - `scope` 'adminAuth' | 'userAuth', required — Scopes of authentication, right know in our system there are only 3 scopes. admin and user. any API route protect by one of them. - `passwordChangeRequired` boolean — Whenever the user required to set new password, during default password usage, password expiration, etc. ## Other responses - `501` — Server error --- [API](https://skmtc.net/casanet/apis/casanet-local-server.md) · [All operations](https://skmtc.net/casanet/apis/casanet-local-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/casanet/casanet-local-server/versions/0f9f76cd80d5/schema)